API Reference
API Reference

Object


Field

Type

Desc

id

string

Subscription unique identifier

customer_id

string

Subotiz customer unique identifier

email

string

Customer email

cycle_index

int

Current cycle index of the subscription

metadata

map[string]string

A set of key-value pairs that can be attached to an object, allowing you to store additional information in a structured format.

cancel_reason

string

Cancel subscription reason

sub_merchant_id

string

Merchant unique identifier

status

string

Subscription business status:

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

price_id

string

Product pricing plan unique identifier

total_cycles

int

Total number of cycles (0 means unlimited)

current_period_start

string

Current billing period start time

current_period_end

string

Current billing period end time

next_invoice_date

string

Next renewal time

created_at

string

Creation time

updated_at

string

Update time

cancel_at

string

Cancel subscription time (optional)

order_id

string

Third-party order ID, same as the order_id passed when creating checkout session.

source_trade_id

string

Trade ID, subscription originated from this trade order.

price_type

string

Price Type