# SubscriptionResponse

> A schema in the One API reference. Source: https://hub.ozow.com/api-reference/one-api/schemas/subscription-response/

A subscription resource, returned by create, get and list.

## Fields

- `subscriptionId` (string, required) - The unique identifier of the subscription.
- `status` (string, required, one of "PendingAuthorization", "Active", "Canceled", "Completed", "Expired", "Failed", "Unknown") - The lifecycle status of a subscription: * `PendingAuthorization` - created, awaiting customer authorisation via `redirectUrl`. * `Active` - authorised; scheduled charges are being taken. * `Canceled` - cancelled; no further charges. * `Completed` - all scheduled occurrences have been taken. * `Expired` - the authorisation lapsed before activation. * `Failed` - the subscription could not be established or sustained. * `Unknown` - the status could not be determined.
- `siteCode` (string, required) - The site code the subscription belongs to.
- `amount` (object, required) - The recurring charge amount.
- `amountConstraints` (object) - The authorised per-payment band. Returned on create and get.
- `payableNow` (object) - The once-off sign-up charge. Returned on create only.
- `description` (string) - The subscription description.
- `merchantReference` (string, required) - Your reference for the subscription.
- `bankReference` (string) - The reference that appears on the merchant's bank statement for each payment in the subscription.
- `frequency` (string, one of "Daily", "Weekly", "Fortnightly", "Monthly", "Biannually", "Annually") - The billing cadence of a subscription.
- `firstPaymentDate` (string, date, required) - The date of the first scheduled charge.
- `occurrences` (integer, required) - The total number of scheduled charges.
- `redirectUrl` (string, uri) - The hosted authorisation page the customer must be redirected to in order to approve the subscription. Present while authorisation is pending.
- `authorization` (object) - The customer's authorisation (consent) status. Populated once the customer has authorised via `redirectUrl`.
  - `status` (string) - The provider-mirrored authorisation status.
- `links` (object, required) - Related resource links for the subscription.
  - `self` (string, uri) - The URI of this subscription.
  - `cancel` (string, uri) - The URI to cancel this subscription.
  - `transactions` (string, uri) - The URI to create an ad-hoc charge against this subscription.