Skip to main content
POST
/
companies
/
{company_id}
/
one_times
Create One-Time Charges
curl --request POST \
  --url https://api.maplebilling.com/api/v1/companies/{company_id}/one_times \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "customer_id": "<string>",
  "onetime_items": [
    {
      "aggregate": 123,
      "custom_price": {
        "amount": {
          "currency": "<string>",
          "value_in_cents": 123
        },
        "product_id": "<string>",
        "description": "<string>"
      },
      "product_pricing_id": "<unknown>",
      "quantity_config": {
        "allow_custom_quantity": true,
        "max_quantity": 123,
        "min_quantity": 123
      },
      "sort_order": "<unknown>"
    }
  ],
  "type": "IMMEDIATE",
  "auto_charges": "<unknown>",
  "discounts": [
    {
      "name": "<string>",
      "type": "DISCOUNT_AMOUNT",
      "amount": {
        "currency": "<string>",
        "value_in_cents": 123
      },
      "cap": {
        "currency": "<string>",
        "value_in_cents": 123
      },
      "coupon_id": "<unknown>",
      "customer_id": "<unknown>",
      "expiration_date": "<unknown>",
      "import_created_at_ref": "<unknown>",
      "import_ref": "<unknown>",
      "imported_from": "<unknown>",
      "item_pricing_id": "<unknown>",
      "onetime_billable_id": "<unknown>",
      "percent": 0.5,
      "product_id": "<unknown>",
      "product_pricing_id": "<unknown>",
      "proposal_id": "<unknown>",
      "state": "ACTIVE",
      "subscription_id": "<unknown>"
    }
  ],
  "invoice_date": "<unknown>",
  "invoice_due_date_from_creation": "<unknown>",
  "invoice_payment_instructions": "<string>",
  "metadata": {},
  "notes": "<unknown>"
}
'
[
  {
    "aggregate": 123,
    "company_id": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "custom_price": {
      "amount": {
        "currency": "<string>",
        "value_in_cents": 123
      },
      "product_id": "<string>",
      "description": "<string>"
    },
    "customer_id": "<unknown>",
    "id": "<string>",
    "name": "<string>",
    "product_pricing": {
      "company_id": "<string>",
      "computed_entitlements": [
        {
          "entitlement_id": "<string>",
          "id": "<string>",
          "inherited_from_id": "<unknown>",
          "inherited_from_type": "<unknown>",
          "key": "<string>",
          "name": "<string>",
          "original_value": "<unknown>",
          "overridden": "<unknown>",
          "type": "<string>",
          "value": "<unknown>"
        }
      ],
      "created_at": "2023-11-07T05:31:56Z",
      "currency": "<string>",
      "description": "<string>",
      "external_name": "<string>",
      "id": "<string>",
      "import_created_at_ref": "<unknown>",
      "import_ref": "<unknown>",
      "imported_from": "<unknown>",
      "metadata": {},
      "name": "<string>",
      "num_subs": 1,
      "override_entitlements": [
        {
          "entitlement_id": "<string>",
          "id": "<string>",
          "inherited_from_id": "<unknown>",
          "inherited_from_type": "<unknown>",
          "key": "<string>",
          "name": "<string>",
          "original_value": "<unknown>",
          "overridden": "<unknown>",
          "type": "<string>",
          "value": "<unknown>"
        }
      ],
      "product": {
        "company_id": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "description": "<string>",
        "entitlements": [
          {
            "entitlement_id": "<string>",
            "id": "<string>",
            "inherited_from_id": "<unknown>",
            "inherited_from_type": "<unknown>",
            "key": "<string>",
            "name": "<string>",
            "original_value": "<unknown>",
            "overridden": "<unknown>",
            "type": "<string>",
            "value": "<unknown>"
          }
        ],
        "external_name": "<string>",
        "id": "<string>",
        "image_url": "<unknown>",
        "import_created_at_ref": "<unknown>",
        "import_ref": "<unknown>",
        "imported_from": "<unknown>",
        "metadata": {},
        "name": "<string>",
        "product_pricings": "<array>",
        "state": "<string>",
        "tags": [
          "<string>"
        ],
        "updated_at": "2023-11-07T05:31:56Z"
      },
      "product_id": "<string>",
      "product_metric_pricings": [
        {
          "company_id": "<string>",
          "created_at": "2023-11-07T05:31:56Z",
          "id": "<string>",
          "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": "<string>",
          "item_pricing": {
            "base_price": {
              "currency": "<string>",
              "value_in_cents": 123
            },
            "base_units": 123,
            "carry_over": true,
            "charge_type": "<string>",
            "company": {
              "address": {
                "address_line_1": "<string>",
                "address_line_2": "<string>",
                "city": "<string>",
                "country": "<string>",
                "place_id": "<unknown>",
                "state": "<string>",
                "zip": "<string>"
              },
              "computed_entitlements": {},
              "created_at": "2023-11-07T05:31:56Z",
              "customer_id": "<unknown>",
              "demo": true,
              "email": "<string>",
              "id": "<string>",
              "is_dev": true,
              "legal_name": "<string>",
              "name": "<string>",
              "phone": "<string>",
              "preferred_currency": "<string>",
              "preferred_timezone": "<string>",
              "slug": "<string>",
              "updated_at": "2023-11-07T05:31:56Z"
            },
            "company_id": "<string>",
            "created_at": "2023-11-07T05:31:56Z",
            "credit_price": {
              "type": "AMOUNT",
              "amount": {
                "currency": "<string>",
                "value_in_cents": 123
              },
              "item_id": "<unknown>",
              "units": 123
            },
            "custom_price": {
              "max_price_per_unit": 123,
              "min_price_per_unit": 123,
              "preset_price_per_unit": 123,
              "price_per_unit": 123
            },
            "description": "<string>",
            "display_type": "<string>",
            "editable": true,
            "external_name": "<string>",
            "fixed_price": {
              "price_per_unit": 123
            },
            "frequency": "<string>",
            "gradient_price": [
              {
                "end": 1,
                "flat_price": 123,
                "is_custom_tier": true,
                "price_per_unit": 123,
                "start": 1
              }
            ],
            "id": "<string>",
            "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": "<string>",
            "metadata": {},
            "minimum_spend": {
              "currency": "<string>",
              "value_in_cents": 123
            },
            "minimum_spend_schedule": {
              "allow_pulling_forward": true,
              "amount_per_period": "<unknown>",
              "minimum_spend_schedule_type": "<string>"
            },
            "name": "<string>",
            "num_subs": 1,
            "proration_type": "<string>",
            "recognition_schedule": {
              "amount_per_period": "<unknown>",
              "recognition_schedule_type": "IMMEDIATE"
            },
            "scheduled_price": {
              "price_per_unit_per_period": [
                "<string>"
              ]
            },
            "state": "<string>",
            "step_price": {
              "price_per_step": 123,
              "step_size": 1
            },
            "term_count": 123,
            "true_up_frequency": "<string>",
            "type": "<string>",
            "updated_at": "2023-11-07T05:31:56Z",
            "volume_price": [
              {
                "flat_price": 123,
                "is_custom_tier": true,
                "price_per_unit": 123,
                "total_units_end": 1,
                "total_units_start": 1
              }
            ]
          },
          "item_pricing_id": "<string>",
          "metric": {
            "company_id": "<string>",
            "created_at": "2023-11-07T05:31:56Z",
            "description": "<string>",
            "external_name": "<string>",
            "id": "<string>",
            "item_id": "<string>",
            "metering_rule": {
              "aggregator": "<string>",
              "group_keys": [
                "<string>"
              ],
              "property": "<string>",
              "rule": "<unknown>"
            },
            "name": "<string>",
            "standard": true,
            "type": "<string>",
            "updated_at": "2023-11-07T05:31:56Z"
          },
          "metric_id": "<string>",
          "product_id": "<string>",
          "updated_at": "2023-11-07T05:31:56Z"
        }
      ],
      "state": "<string>",
      "tags": [
        "<string>"
      ],
      "type": "<string>",
      "updated_at": "2023-11-07T05:31:56Z",
      "upsell_product_pricing_id": "<unknown>"
    },
    "product_pricing_id": "<unknown>",
    "quantity_config": {
      "allow_custom_quantity": true,
      "max_quantity": 123,
      "min_quantity": 123
    },
    "sort_order": "<unknown>",
    "state": "<string>",
    "type": "<string>",
    "updated_at": "2023-11-07T05:31:56Z"
  }
]

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 to whom the one-time charges belong

​
onetime_items
object[]
required

The list of one-time charges

​
type
enum<string>
required

The type of one-time charges which can be IMMEDIATE or NEXT depending on whether they are invoiced immediately or on the next invoice for the customer

Available options:
IMMEDIATE,
NEXT
​
auto_charges
null | boolean

Whether the one-time charges are automatically charged to the payment method for the customer

​
discounts
object[] | null

The discounts attached to the one-time charges

​
invoice_date
null | string<date-time>

The date of invoice for the customer

​
invoice_due_date_from_creation
null | integer

Number of days before the invoice is due (from the invoice date)

Required range: x >= 0
​
invoice_payment_instructions
string | null

The payment instructions for the customer

​
metadata
object

Any additional data as key-value pairs attached to the charge

​
notes
null | string

The notes attached to the one-time charges

Response

201 - application/json

Created

​
aggregate
number<double>
​
company_id
string
​
created_at
string<date-time>
​
custom_price
object
​
customer_id
null | string
​
id
string
​
name
string
​
product_pricing
object
​
product_pricing_id
null | string
​
quantity_config
object
​
sort_order
null | number
​
state
string
​
type
string
​
updated_at
string<date-time>