The Subscription Object

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

Field

Type

Description

period_duration

string

Subscription period, specified in ISO 8601 format.

started

timestamp

Initial transaction date. For a subscription with a trial period, the trial start date.

current_period_start

timestamp

Start of the current subscription period.

current_period_end

timestamp

End of the current subscription period that the subscription has been invoiced for.

current_period_type

string

Possible values:
normal: the product is in it's normal period
trial: free trial period
intro: introductory pricing period

renew_state

string

A 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.

object

string

The value is subscription. String representing the object’s type.