API Reference
API Reference

Object


FieldTypeDesc
idstringSubscription unique identifier
customer_idstringSubotiz customer unique identifier
emailstringCustomer email
cycle_indexintCurrent cycle index of the subscription
metadatamap[string]stringA set of key-value pairs that can be attached to an object, allowing you to store additional information in a structured format.
cancel_reasonstringCancel subscription reason
sub_merchant_idstringMerchant unique identifier
statusstringSubscription business status:
  • init - Pending activation
  • trial - Trial period
  • active - Active
  • paused - Paused
  • past_due - Past due
  • unpaid - Unpaid
  • canceled - Canceled
  • incomplete - Incomplete
price_idstringProduct pricing plan unique identifier
total_cyclesintTotal number of cycles (0 means unlimited)
current_period_startstringCurrent billing period start time
current_period_endstringCurrent billing period end time
next_invoice_datestringNext renewal time
created_atstringCreation time
updated_atstringUpdate time
cancel_atstringCancel subscription time (optional)
order_idstringThird-party order ID, same as the order_id passed when creating checkout session.
source_trade_idstringTrade ID, subscription originated from this trade order.
price_typestringPrice Type
price_version_idstringProduct pricing plan version unique identifier
first_source_channelstringThe source where this checkout session was initially created
last_source_channelstringThe source where this checkout session was last accessed
fixed_termstringNumber of fixed-term periods. "0" indicates an ongoing subscription (no fixed term)
is_renewableboolWhether the subscription automatically converts to an ongoing subscription upon expiration
end_atstringSubscription end time. An empty string indicates an ongoing subscription (no end time)
current_periodintCurrent period number of the subscription
is_cancelingboolWhether the subscription is pending cancellation
launch_cancel_atstringThe time when the cancellation was initiated
expected_cancel_atstringThe expected date of subscription cancellation