Ozow Hub

SubscriptionResponse

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

On this page2 sections

Fields

  • subscriptionId string required

    The unique identifier of the subscription.

  • status SubscriptionStatus required

    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.
    values"PendingAuthorization""Active""Canceled""Completed""Expired""Failed""Unknown"
  • siteCode string required

    The site codeSite code The unique code for a site registered under a merchant. A site is a place to transact: a website, or a branch of a store. A merchant can have several, and each transaction names the one it belongs to, so sending the wrong code files the payment against the wrong place. the subscription belongs to.

  • amount Amount required

    The recurring charge amount.

    Fields of Amount
    • currency string required

      The ISO 4217ISO 4217 The three-letter currency codes, such as ZAR for the South African rand. Always uppercase.Wikipedia current code.

      min length3max length3
    • value number float required

      The amount in the currency specified.

      min0.01
    Open Amount on its own page
  • amountConstraints AmountConstraints

    The authorised per-payment band. Returned on create and get.

    Fields of AmountConstraints
    • min Amount required

      The minimum authorised per-payment amount. Whole RandZAR The ISO 4217 code for the South African rand, and the currency every amount on this site is in unless a page says otherwise. Amounts are decimal rand rather than cents, so 100.00 is one hundred rand., greater than 0.

      Fields of Amount
      • currency string required

        The ISO 4217ISO 4217 The three-letter currency codes, such as ZAR for the South African rand. Always uppercase.Wikipedia current code.

        min length3max length3
      • value number float required

        The amount in the currency specified.

        min0.01
      Open Amount on its own page
    • max Amount required

      The maximum authorised per-payment amount. Whole RandZAR The ISO 4217 code for the South African rand, and the currency every amount on this site is in unless a page says otherwise. Amounts are decimal rand rather than cents, so 100.00 is one hundred rand., greater than min, and not exceeding 100000.

      Fields of Amount
      • currency string required

        The ISO 4217ISO 4217 The three-letter currency codes, such as ZAR for the South African rand. Always uppercase.Wikipedia current code.

        min length3max length3
      • value number float required

        The amount in the currency specified.

        min0.01
      Open Amount on its own page
    Open AmountConstraints on its own page
  • payableNow PayableNow

    The once-off sign-up charge. Returned on create only.

    Fields of PayableNow
    • amount Amount required

      The once-off charge amount. Must be ZAR.

      Fields of Amount
      • currency string required

        The ISO 4217ISO 4217 The three-letter currency codes, such as ZAR for the South African rand. Always uppercase.Wikipedia current code.

        min length3max length3
      • value number float required

        The amount in the currency specified.

        min0.01
      Open Amount on its own page
    • date string date required

      The date the once-off charge is taken. Must be today or a future date.

    Open PayableNow on its own page
  • 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 SubscriptionFrequency

    The billing cadence of a subscription.

    values"Daily""Weekly""Fortnightly""Monthly""Biannually""Annually"
  • 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.

Used by