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
CreatedAtdatetimeOptional
Timestamp of when the subscription ws created, in UTC.
CustomerobjectOptional
EndDatedatetimeOptional
The subscription's end date.
EntrypageIdlongOptional
If applicable, the internal reference ID to the payment page capturing the payment.
ExternalPaypointIDstringOptional

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.

FeeAmountdoubleOptional
Fee applied to the subscription.
FrequencystringOptional
The subscription's frequency.
IdSublongOptional
The subscription's ID.
InvoiceDataobjectOptional
LastRundatetimeOptional
The last time the subscription was processed.
LastUpdateddatetimeOptional
The last date and time the subscription was updated.
LeftCyclesintegerOptional
The number of cycles the subscription has left.
MethodstringOptional
The subscription's payment method.
NetAmountdoubleOptional
The subscription amount, minus any fees.
NextDatedatetimeOptional
The next date the subscription will be processed.
ParentOrgNamestringOptional
The name of the parent organization.
PaymentDataobjectOptional
PaypointDbanamestringOptional
The paypoint's DBA name.
PaypointEntrynamestringOptional<=50 characters
The paypoint's entryname.
PaypointIdlongOptional
The paypoint's ID. Note that this is different than the entryname.
PaypointLegalnamestringOptional
The paypoint's legal name.
PlanIdintegerOptional
Payment plan ID.
SourcestringOptional<=100 characters
Custom identifier to indicate the transaction or request source.
StartDatedatetimeOptional
The subscription start date.
SubEventslist of objectsOptional
Events associated with the subscription.
SubStatusintegerOptional

The subscription’s status.

  • 0: Paused
  • 1: Active
TotalAmountdoubleOptional
The subscription amount, including any fees.
TotalCyclesintegerOptional
The total number of cycles the subscription is set to run.
UntilCancelledbooleanOptional

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