Sign in

v1

latestOpenAPI 3.0.32026-07-26618696.8 KB
Subscriptions

Retrieve Subscriptions

get/api/v1/subscriptions/{id}/

Path parameters

idstring required

A unique string value identifying this Subscription.

Response

subscription_idstring required
referencestring nullable

Third-party reference ID

payment_method'CARD-PAYMENT'
  • CARD-PAYMENT - CARD-PAYMENT
card_maskstring nullable required

Masked card

card_expirystring date nullable required
status'PENDING' | 'ACTIVE' | 'CANCELED' | 'COMPLETE' | 'FAILED'
  • PENDING - PENDING
  • ACTIVE - ACTIVE
  • CANCELED - CANCELED
  • COMPLETE - COMPLETE
  • FAILED - FAILED
start_datestring date required
next_datestring date nullable
completed_cyclesinteger
fail_reasonstring nullable
setup_urlstring required
redirect_urlstring uri nullable

Redirect your customer after successful payment

created_atstring date-time nullable required
updated_atstring date-time nullable required