pause Subscription

Pause a subscription, for a duration indicated by an oprional ‘cycles’ payload variable. Default is 1 if not given.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Subscription token.

Query Params
boolean
Defaults to true

Set to true when calling sandbox/testing mode (where supported).

Form Data
string

Optional. Number of cycles to pause the subscription for. Default is 1 if not given.

Headers
string
required

Merchant ID issued by PayFast.

string
required

API version.

date-time
required

Request timestamp. Use ISO-8601 format.

string
required

MD5 signature of the request fields (URL-encoded values) plus passphrase. For API requests, fields are sorted alphabetically by key and the signature must be lowercase.

Responses

400

Bad request.

401

Authentication / signature error.

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json