The Subscription Object

Subscription object containing the data on a subscription duration, type, and other subscription details as shown below.

FieldTypeDescription
period_durationstringSubscription period, specified in ISO 8601 format.
startedtimestampInitial transaction date. For a subscription with a trial period, the trial start date.
current_period_starttimestampStart of the current subscription period.
current_period_endtimestampEnd of the current subscription period that the subscription has been invoiced for.
current_period_typestringPossible values:
normal: the product is in it's normal period
trial: free trial period
intro: introductory pricing period
renew_statestringA renewal state of the product. It can have the following values:
will_renew: subscription is active, and auto-renew status is on
canceled: auto-renew status is off
billing_issue: there was some billing issue.
objectstringThe value is subscription. String representing the object’s type.