Corrily home pagelight logo
Charges
Create charge
POST

/v1/charges

X-Api-Key*
curl --request POST \
  --url https://client.corrily.com/v1/charges \
  --header 'X-Api-Key: <x-api-key>' \
  --data '{
  "amount": "<amount>",
  "created": 0,
  "currency": "<currency>",
  "origin": "<origin>",
  "origin_id": "<origin_id>",
  "product": "<product>",
  "status": "<status>",
  "user_id": "<user_id>"
}'
curl --request POST \
     --url https://client.corrily.com/v1/charges \
     --header 'Accept: application/json' \
     --header 'Content-Type: application/json' \
     --data '
{
     "amount": 50,
     "amount_refunded": 0,
     "created": 1662444537,
     "currency": "USD",
     "country": "US",
     "origin": "stripe",
     "origin_id": "sub_JaHy9Kl6ZMLvId",
     "product": "monthly",
     "status": "succeeded",
     "user_id": "test_user"
}
'

Custom payment gateway integrations only

You do not need to use this endpoint if you have granted Corrily automated access to your payment gateway’s subscription and charge events.

​
Body Params

amountrequired
float

The amount (price) of the charge.

amount_refundedDefault: "0"
float

The amount refunded by the charge. Only required if amount is undefined.

createdrequired
integer

A 10-digit (seconds) UNIX timestamp indicating when the charge was created. This timestamp should represent when the charge was initialized, regardless of the status of the charge during the initialization. It’s rare to need to update created after initially setting it.

currencyrequired
string

The three-letter (ISO 4217) currency code.

country
string

User’s two-letter ISO3166 country code.

originrequired
string

The payment gateway that handled the charge. Accepted values: stripe, paypal, chargebee.

origin_idrequired
string

A unique identifier for the charge. This can be the ID that the payment gateway assigned to the charge.

productrequired
string

A product ID string or a payment gateway integration object. Product IDs are created by Corrily when you set up your Corrily account. Email support@corrily.com if you don’t know them. See the response of the calculate price endpoint for an example of the structure of integration objects.

statusrequired
string

The status of the charge. Accepted values: pending, succeeded, failed.

user_idrequired
string

A User ID.

metadata
object

Free form key-value data. Metadata is useful for storing additional, structured information for a charge.