Replace subscription payment details

1 parameter · 4 body fields

idintegerrequired

The integer ID of the subscription to update.

Payment details to update for the subscription; all fields are optional.

amountstringoptional

The new amount in cents which will be payed on the next payment interval.

currencystringoptional

The ISO code of the currency of the payment.

purposestringoptional

The payment purpose. What is the payer paying for?

vatRatestringoptional

VAT Rate Percentage

3 status codes

200Returns an object containing the updated subscription record in a `data` array and a `status` field.

dataarray<object>optional

statusstringoptional

400Returned when a supplied field value is invalid.

errorobjectoptional

messagestringoptional

reasonstringoptional

statusstringoptional

404Returned when no subscription exists with the supplied ID.

errorobjectoptional

messagestringoptional

reasonstringoptional

statusstringoptional

Error handling

A 400 is returned when a supplied field value is invalid. A 404 is returned when no subscription exists with the supplied ID. The id path parameter must identify the subscription to update.

client := payrexxdemo.NewClient("https://api.payrexx.com/v1.16")

result, err := client.Subscription.Update(
	ctx,
	&UpdateSubscriptionParams{
		Id: "9b2f1c10-7a3e-4d54-8c2a-1f6b9e0d4a21",
		Amount: 1999,
		Currency: "USD",
		Purpose: "example",
		VatRate: "example",
	},
)
if err != nil {
	log.Fatal(err)
}

"{\n    \"status\": \"success\",\n    \"data\": [\n        {\n            \"id\": 1,\n            \"status\": \"active\",\n            \"start\": \"2014-12-18\",\n            \"end\": null,\n            \"valid_until\": \"2015-01-18\",\n            \"invoice\": {\n                \"number\": \"Test subscription\",\n                \"amount\": 1,\n                \"currency\": \"CHF\",\n                \"referenceId\": \"\",\n                \"paymentRequestId\": null,\n                \"paymentLink\": null\n            },\n            \"contact\": {\n                \"id\": 1,\n                \"title\": \"\",\n                \"firstname\": \"\",\n                \"lastname\": \"\",\n                \"company\": \"\",\n                \"street\": \"\",\n                \"zip\": \"\",\n                \"place\": \"\",\n                \"country\": \"\",\n                \"countryISO\": \"\",\n                \"phone\": \"\",\n                \"email\": \"user@example.com\",\n                \"date_of_birth\": \"\"\n            }\n        }\n    ]\n}"

Request

Response

Errors