API referencePay In endpointsSubscriptions

Get subscription

Retrieves a single subscription's details.

Authentication

requestTokenstring
API Key authentication via header

Path parameters

subIdintegerRequired
The subscription ID.

Response

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

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

The subscription’s status.

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

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

Errors

400
Bad Request Error
401
Unauthorized Error
500
Internal Server Error
503
Service Unavailable Error