Skip to main content
POST
/
credits
/
{credit_id}
/
apply
Apply a credit memo to an order
curl --request POST \
  --url https://api.arcuserp.com/v1/credits/{credit_id}/apply \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "order_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "amount": 123,
  "notes": "<string>"
}
'
{}

Documentation Index

Fetch the complete documentation index at: https://docs.arcuserp.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

API key issued per entity via Settings > Developers > API Keys. Each key carries scopes (e.g. orders:read, products:write). Bearer token format: Authorization: Bearer ark_live_ent_Test keys use ark_test_ent_. Both are issued per entity
via Settings > Developers > API Keys.

Path Parameters

​
credit_id
string<uuid>
required

Body

application/json
​
order_id
string<uuid>
required
​
amount
number

Amount to apply in dollars; omit to apply full available balance

​
notes
string

Response

Credit applied

The response is of type object.