Skip to main content
GET
Get purchased subscription billing details

Authorizations

Authorization
string
header
required

OAuth 2.0 Authentication

Path Parameters

autobillId
string
required

The autobillId of the Subscription.

Response

OK

Subscription billing details.

id
string
required

A unique identifier.

Maximum string length: 256
vid
string
required

A Globally Unique Identifier (GUID) for this object. This value is generated by MarketONE.

Maximum string length: 128
created
string

The date/time at which the subscription was requested.

status
enum<string>

The status of the subscription from a service and entitlement perspective.

Available options:
Pending Activation,
Active,
Paused,
Pending Pause,
Pending Resume,
Pending Cancel,
Cancelled,
Expired,
Processing,
Deleted,
Dryrun,
Unknown,
Upgraded,
Legacy Suspended,
Bogus AutoBill Status
payment_method
object
billing_plan
object
billing_state
enum<string>

The financial state of the subscription.

Available options:
Free/Trial,
Billing Completed,
Failed To Collect,
Free Period,
Paused,
Good Standing,
Grace Period,
In Retry,
Legacy Unknown BillingState,
Overdue,
Pending Acceptance,
Terminated,
Unbilled,
Unknown,
Unusable PaymentMethod,
Pending Resume,
Pending Pause,
Bogus BillingState
starts
string

The date/time the subscription starts service.

ends
string

The date/time the subscription ends service.

entitled_through
string

The date/time to which the subscription will entitle service if no further payments are made – a “paid thru” date based on billing schedule and grace period.

billing_day
integer

The day of the month on which the subscription is (typically) billed. Often called an “anniversary date.”

minimum_commitment
integer

Number of billing cycles customer is obligated to maintain the subscription. Cancelling before this time requires aggregator to “force” cancellation.

most_recent_billing
object

The Transaction object returning information about a customer charge.

next_billing
object

The Transaction object returning information about a customer charge.

balance
number