Ask the merchant to pay for something: a one-time, recurring or usage-capped charge. Returns a confirmationUrl; nothing is billed until the merchant approves it in CIQRA.
POST
/apps/billing/charges
const url = 'https://your-store.myciqra.com/apps/billing/charges';const options = { method: 'POST', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"amount":1,"cappedAmount":1,"currency":"example","interval":"example","kind":"example","name":"example","returnUrl":"example","terms":"example","test":true,"trialDays":1}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://your-store.myciqra.com/apps/billing/charges \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "amount": 1, "cappedAmount": 1, "currency": "example", "interval": "example", "kind": "example", "name": "example", "returnUrl": "example", "terms": "example", "test": true, "trialDays": 1 }'Any installation token — billing needs no scope. Each charge reaches the merchant’s invoice only after the merchant approves it in the CIQRA admin.
Authorizations
Section titled “Authorizations”Request Bodyrequired
Section titled “Request Bodyrequired”Media typeapplication/json
object
amount
required
integer | string format: int64
cappedAmount
required
null | integer | string format: int64
currency
required
null | string
interval
required
null | string
kind
required
null | string
name
required
null | string
returnUrl
required
null | string
terms
required
null | string
test
required
boolean
trialDays
required
integer | string format: int32
Examplegenerated
{ "amount": 1, "cappedAmount": 1, "currency": "example", "interval": "example", "kind": "example", "name": "example", "returnUrl": "example", "terms": "example", "test": true, "trialDays": 1}Responses
Section titled “Responses”OK