update Subscription

patch

https://api.payfast.co.za/subscriptions/{subscription_token}/update

This allows for multiple subscription values to be updated. The body must contain at least one of the optional payload variables.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

subscription_token

string

required

Subscription token.

Query Params

testing

boolean

Defaults to true

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

Form Data

cycles

string

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

frequency

string

Optional. Frequency for the subscription

run_date

string

Optional. Next run date for the subscription.

amount

string

Optional. Amount which the buyer must pay, in CENTS (ZAR).

Headers

merchant-id

string

required

Merchant ID issued by PayFast.

version

string

required

API version.

timestamp

date-time

required

Request timestamp. Use ISO-8601 format.

signature

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

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successful response.