APIPay In endpointsSubscriptions

Get subscription

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

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.

CreatedAtdatetimeOptional
Timestamp of when the subscription ws created, in UTC.
CustomerobjectOptional
EntrypageIdlongOptional
If applicable, the internal reference ID to the payment page associated with the transaction.
ExternalPaypointIDstringOptional
A custom identifier for the paypoint, if applicable.
FeeAmountdoubleOptional
Fee applied to the subscription.
FrequencystringOptional
The subscription's frequency.
IdSublongOptional
The subscription's ID.
invoiceDataobjectOptional
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.
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.
SubEventslist of objectsOptional
Events associated with the subscription.
SubStatusintegerOptional

The subscription’s status.

  • 0: Paused
  • 1: Active
SubscriptionTypeenum or nullOptional

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

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