Skip to main content
POST
/
companies
/
{company_id}
/
credits
Create Credit
curl --request POST \
  --url https://api.maplebilling.com/api/v1/companies/{company_id}/credits \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "amount": {
    "currency": "<string>",
    "value_in_cents": 123
  },
  "apply_to_open_invoices": {
    "enable": true,
    "invoice_uuids": [
      "<string>"
    ]
  },
  "customer_id": "<string>",
  "expiration_date": null,
  "item_id": null,
  "name": "<string>",
  "state": "ACTIVE",
  "subscription_id": null,
  "type": "AMOUNT",
  "units": 123
}'
{
  "amount": {
    "currency": "<string>",
    "value_in_cents": 123
  },
  "coupon_id": null,
  "created_at": "2023-11-07T05:31:56Z",
  "customer_id": "<string>",
  "expiration_date": null,
  "id": "<string>",
  "import_created_at_ref": null,
  "import_ref": null,
  "imported_from": null,
  "issued_amount": {
    "currency": "<string>",
    "value_in_cents": 123
  },
  "issued_units": 123,
  "item": {
    "company_id": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "description": "<string>",
    "display_type": "<string>",
    "editable": true,
    "external_name": "<string>",
    "id": "<string>",
    "name": "<string>",
    "standard": true,
    "type": "<string>",
    "updated_at": "2023-11-07T05:31:56Z"
  },
  "item_id": null,
  "metric_record_id": null,
  "name": "<string>",
  "one_time_billable_id": null,
  "proration_date": null,
  "state": "<string>",
  "subscription_id": null,
  "type": "<string>",
  "units": 123
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
Idempotency-Key
string

The idempotency key that will be used to ensure the request is only performed once

Path Parameters

​
company_id
string
required

The company ID with the prefix 'cmp_'.

Body

application/json
​
customer_id
string
required

The customer ID for the customer to whom the credit will be attached

​
name
string
required

The name of the credit. This will show up in invoices

​
state
enum<string>
required

The state of the credit that can be one of ACTIVE, REVOKED, EXPIRED or CONSUMED

Available options:
ACTIVE,
REVOKED,
EXPIRED,
CONSUMED
​
type
enum<string>
required

The type of the credit that can be one of AMOUNT or UNITS

Available options:
AMOUNT,
UNITS
​
amount
object

The amount of the credit, if the type of credit is AMOUNT

​
apply_to_open_invoices
object
​
expiration_date
string<date-time> | null

The expiration date for the credit in RFC-3339 format

​
item_id
string | null

The billable item ID for the type of unit credits

​
subscription_id
string | null

The specific subscription ID to which the credit is attached

​
units
number

The number of units of the credit, if the type of credit UNITS

Response

201 - application/json

Created

​
amount
object

The amount which has value in cents and a currency

​
coupon_id
string | null
​
created_at
string<date-time>
​
customer_id
string
​
expiration_date
string<date-time> | null
​
id
string
​
import_created_at_ref
string<date-time> | null
​
import_ref
string | null
​
imported_from
string | null
​
issued_amount
object

The amount which has value in cents and a currency

​
issued_units
number
​
item
object
​
item_id
string | null
​
metric_record_id
string | null
​
name
string
​
one_time_billable_id
string | null
​
proration_date
string<date-time> | null
​
state
string
​
subscription_id
string | null
​
type
string
​
units
number
⌘I