API referencePay In endpointsSubscriptions

Get subscription

Retrieves a single subscription's details.

Path parameters

subIdintegerRequired
The subscription ID.

Headers

requestTokenstringRequired

Response

Success
CreatedAtdatetime or null
Timestamp of when the subscription ws created, in UTC.
Customerobject or null
EndDatedatetime or null
The subscription's end date.
EntrypageIdlong or null
If applicable, the internal reference ID to the payment page capturing the payment.
ExternalPaypointIDstring or null

A custom identifier for the paypoint, if applicable. Like entrypoint is the Payabli identifier for the merchant, externalPaypointId is a custom field you can use to include the merchant’s ID from your own systems.

FeeAmountdouble or null
Fee applied to the subscription.
Frequencystring or null
The subscription's frequency.
IdSublong or null
The subscription's ID.
InvoiceDataobject or null
LastRundatetime or null
The last time the subscription was processed.
LastUpdateddatetime or null
The last date and time the subscription was updated.
LeftCyclesinteger or null
The number of cycles the subscription has left.
Methodstring or null
The subscription's payment method.
NetAmountdouble or null
The subscription amount, minus any fees.
NextDatedatetime or null
The next date the subscription will be processed.
ParentOrgNamestring or null
The name of the parent organization.
PaymentDataobject or null
PaypointDbanamestring or null
The paypoint's DBA name.
PaypointEntrynamestring or null<=50 characters
The paypoint's entryname.
PaypointIdlong or null
The paypoint's ID. Note that this is different than the entryname.
PaypointLegalnamestring or null
The paypoint's legal name.
PlanIdinteger or null
Payment plan ID.
Sourcestring or null<=100 characters
Custom identifier to indicate the transaction or request source.
StartDatedatetime or null
The subscription start date.
SubEventslist of objects or null
Events associated with the subscription.
SubStatusinteger or null

The subscription’s status.

  • 0: Paused
  • 1: Active
TotalAmountdouble or null
The subscription amount, including any fees.
TotalCyclesinteger or null
The total number of cycles the subscription is set to run.
UntilCancelledboolean or null

When true, the subscription has no explicit end date and will run until canceled.

Errors