Refund Prepayment

Server URLloading...

POST

/subscriptions/{subscription_id}/prepayments/{prepayment_id}/refunds.json

Send

Authorization

Path

Body

Refunds a prepayment applied to a subscription, either fully or partially. The prepayment_id will be the account transaction ID of the original payment. The prepayment must have some amount remaining in order to be refunded.

The amount may be passed either as a decimal, with amount, or an integer in cents, with amount_in_cents.

Path ParametersCopy Anchor Link

Response BodyCopy Anchor Link

curl -X POST "https://example.com/subscriptions/0/prepayments/0/refunds.json" \  -H "Content-Type: application/json" \  -d '{    "refund": {      "amount_in_cents": 0,      "amount": "string",      "memo": "string"    }  }'

{  "prepayment": {    "id": 0,    "subscription_id": 0,    "amount_in_cents": 0,    "remaining_amount_in_cents": 0,    "refunded_amount_in_cents": 0,    "details": "string",    "external": true,    "memo": "string",    "payment_type": "check",    "created_at": "2019-08-24T14:15:22Z"  }}