Skip to main content
POST
/
customers
/
{customer_id}
/
addCharge
Add a one time charge
curl --request POST \
  --url https://api.metronome.com/v1/customers/{customer_id}/addCharge \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "charge_id": "5ae4b726-1ebe-439c-9190-9831760ba195",
  "price": 250,
  "quantity": 1,
  "description": "One time charge",
  "invoice_start_timestamp": "2024-01-01T00:00:00Z",
  "customer_plan_id": "a23b3cf4-47fb-4c3f-bb3d-9e64f7704015"
}'
{}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
customer_id
string<uuid>
required

Body

application/json

One time charge creation request

​
charge_id
string<uuid>
required

The Metronome ID of the charge to add to the invoice. Note that the charge must be on a product that is not on the current plan, and the product must have only fixed charges.

​
price
number
required

The price of the charge. This price will match the currency on the invoice, e.g. USD cents.

​
quantity
number
required
​
description
string
required
​
customer_plan_id
string<uuid>
required

The Metronome ID of the customer plan to add the charge to.

​
invoice_start_timestamp
string<date-time>
required

The start_timestamp of the invoice to add the charge to.

Response

200 - application/json

Success

The response is of type object.

⌘I