API Reference
Log in
API Reference

Object

Field

Type

Desc

id

string

Subscription plan unique identifier

customer_id

string

Customer unique identifier

order_id

string

External order ID

email

string

Customer email

cycle_index

int

Current cycle number

metadata

map<string, string>

Transmitted metadata

cancel_reason

string

Reason for subscription termination

sub_merchant_id

string

Sub-merchant unique identifier

status

string

Subscription status:

  • init - Pending activation
  • trial - Trial period
  • active - Active
  • canceled - Canceled
  • incomplete - Incomplete

price_id

int

Unique identifier for product pricing

total_cycles

int

Total number of cycles, 0 for indefinite

current_period_start

string

Current billing period start time

current_period_end

string

Current billing period end time

next_invoice_date

string

Next invoice date

created_at

string

Creation time

updated_at

string

Update time

cancel_at

string

Subscription termination time