Use it to retrieve the current configuration and status of a subscription (for example amount, frequency, next run date, and active state).

Fetch a subscription object

Method: GET
Endpoint: /subscriptions/:token/fetch

https://api.payfast.co.za/subscriptions/dc0521d3-55fe-269b-fa00-b647310d760f/fetch

Parameters

Path parameters

Name	Type	Required	Description
`token`	string	Yes	The unique ID on PayFast that represents the subscription.

Headers

Name	Type	Required	Description
`merchant-id`	integer (8 char)	Yes	The Merchant ID as issued by PayFast.
`version`	string	Yes	The PayFast API version (for example `v1`).
`timestamp`	ISO-8601 datetime	Yes	The current timestamp (`YYYY-MM-DDTHH:MM:SS[+HH:MM]`). Include the timezone offset.
`signature`	string	Yes	MD5 hash of the alphabetised submitted header and body variables, plus the passphrase. Must be lowercase.

Note: For API requests, build the signature string using parameters sorted alphabetically by key, and URL-encode values before hashing.

Response (Recurring)

A successful response returns a subscription object in data.response.

Example response

{
  "code": 200,
  "status": "success",
  "data": {
    "response": {
      "amount": 1628,
      "cycles": 14,
      "cycles_complete": 9,
      "frequency": 3,
      "run_date": "2020-07-04T00:00:00+02:00",
      "status": 1,
      "status_reason": "",
      "status_text": "ACTIVE",
      "token": "a3b3ae55-ab8b-b388-df23-4e6882b86ce0"
    }
  }
}

Subscription object fields

Field	Type	Description
`amount`	number	Subscription amount (as returned by the API).
`cycles`	number	Total number of cycles configured for the subscription.
`cycles_complete`	number	Number of cycles completed so far.
`frequency`	number	The billing frequency value (as returned by the API).
`run_date`	string (ISO-8601)	The scheduled run date/time (includes timezone offset).
`status`	number	Subscription status value (numeric).
`status_text`	string	Human-readable status (for example `ACTIVE`).
`status_reason`	string	Additional status detail (may be blank).
`token`	string	Subscription identifier token.