APIPay In endpointsSubscriptions

Get subscription

View as MarkdownOpen in Claude
Retrieves a single subscription's details.

Authentication

requestTokenstring
API Key authentication via header

Path parameters

subIdintegerRequired
The subscription ID.

Response

Success
EndDatedatetime or null
The subscription's end date.
LastRundatetime or null
The last time the subscription was processed.
NextDatedatetime or null
The next date the subscription will be processed.
StartDatedatetime or null
The subscription start date.
StoredMethodobject or null

The full stored payment method record linked to the subscription and charged on each billing cycle. Returned as null for legacy subscriptions that don’t have a linked stored method. The shape is the same across payment vehicles (card, ACH, check). Only the populated fields differ. For example, ABA is populated for ACH, while ExpDate and binData are populated for card.

CreatedAtdatetime
Timestamp of when the subscription ws created, in UTC.
Customerobject
EntrypageIdlong
If applicable, the internal reference ID to the payment page associated with the transaction.
ExternalPaypointIDstring
A custom identifier for the paypoint, if applicable.
FeeAmountdouble
Fee applied to the subscription.
Frequencystring
The subscription's frequency.
IdSublong
The subscription's ID.
invoiceDataobject
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.
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.
SubEventslist of objects
Events associated with the subscription.
SubStatusinteger

The subscription’s status.

  • 0: Paused
  • 1: Active
SubscriptionTypeenum or null

Subscription type or category. Returns null when no type is assigned.

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