Create Product Pricing

POST

companies

{company_id}

pricing

curl --request POST \
  --url https://api.maplebilling.com/api/v1/companies/{company_id}/pricing \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "base_price": {
    "currency": "<string>",
    "value_in_cents": 123
  },
  "base_units": 1,
  "billing_frequency": {
    "count": 123,
    "frequency": "HOUR"
  },
  "carryover": true,
  "charge_type": null,
  "credit_price": {
    "amount": {
      "currency": "<string>",
      "value_in_cents": 123
    },
    "item_id": null,
    "type": "AMOUNT",
    "units": 123
  },
  "currency": "<string>",
  "description": "<string>",
  "display_type": null,
  "entitlements": [
    {
      "entitlement_id": "<string>",
      "id": "<string>",
      "key": "<string>",
      "value": "<any>"
    }
  ],
  "external_name": "<string>",
  "fixed_price": {
    "price_per_unit": 123
  },
  "gradient_price": [
    {
      "end": 1,
      "flat_price": 123,
      "is_custom_tier": true,
      "price_per_unit": 123,
      "start": 1
    }
  ],
  "item_id": null,
  "metadata": {},
  "metric_id": null,
  "minimum_spend": {
    "currency": "<string>",
    "value_in_cents": 123
  },
  "minimum_spend_schedule": {
    "allow_pulling_forward": true,
    "amount_per_period": null,
    "minimum_spend_schedule_type": "<string>"
  },
  "name": "<string>",
  "pricing_type": "FIXED",
  "product_id": "<string>",
  "proration_type": null,
  "recognition_schedule": {
    "amount_per_period": null,
    "recognition_schedule_type": "<string>"
  },
  "scheduled_price": {
    "price_per_unit_per_period": [
      "<string>"
    ]
  },
  "step_price": {
    "price_per_step": 123,
    "step_size": 1
  },
  "tags": [
    "<string>"
  ],
  "true_up_frequency": "<string>",
  "type": "<string>",
  "volume_price": [
    {
      "flat_price": 123,
      "is_custom_tier": true,
      "price_per_unit": 123,
      "total_units_end": 1,
      "total_units_start": 1
    }
  ]
}'

{
  "company_id": "<string>",
  "computed_entitlements": [
    {
      "entitlement_id": "<string>",
      "id": "<string>",
      "inherited_from_id": null,
      "inherited_from_type": null,
      "key": "<string>",
      "name": "<string>",
      "original_value": "<any>",
      "overridden": null,
      "type": "<string>",
      "value": "<any>"
    }
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "currency": "<string>",
  "description": "<string>",
  "external_name": "<string>",
  "id": "<string>",
  "metadata": {},
  "name": "<string>",
  "num_subs": 1,
  "override_entitlements": [
    {
      "entitlement_id": "<string>",
      "id": "<string>",
      "inherited_from_id": null,
      "inherited_from_type": null,
      "key": "<string>",
      "name": "<string>",
      "original_value": "<any>",
      "overridden": null,
      "type": "<string>",
      "value": "<any>"
    }
  ],
  "product_id": "<string>",
  "state": "<string>",
  "tags": [
    "<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

currency

string

required

The currency for the product pricing

name

string

required

The name of the product pricing

pricing_type

enum<string>

required

Available options:

FIXED,

STEP,

GRADIENT,

VOLUME,

CUSTOM,

SCHEDULED

product_id

string

required

The product ID of the product to which this pricing belongs

type

string

required

base_price

object

The amount which has value in cents and a currency

Show child attributes

base_units

number

Required range: x >= 0

billing_frequency

object

The term which includes a frequency interval and a count for number of intervals

Show child attributes

carryover

boolean

charge_type

enum<string> | null

Available options:

PRE_POST,

POST_ONLY

credit_price

object

Show child attributes

description

string

The description for the product pricing

display_type

string | null

entitlements

object[] | null

The entitlements that enable features for the product pricing

Show child attributes

external_name

string

The externally visible name for the product pricing

fixed_price

object

Show child attributes

gradient_price

object[] | null

Show child attributes

item_id

string | null

The item ID of the product pricing. Used only for variable pricing

metadata

object

Any additional data as key-value pairs that need to be attached to the product pricing

metric_id

string | null

The billable metric ID of the product pricing. Used only for variable pricing

minimum_spend

object

The amount which has value in cents and a currency

Show child attributes

minimum_spend_schedule

object

Show child attributes

proration_type

enum<string> | null

Available options:

NONE,

PRORATE_ALL

recognition_schedule

object

Show child attributes

scheduled_price

object

Show child attributes

step_price

object

Show child attributes

Response

200 - application/json

company_id

string

The company ID for the product pricing

computed_entitlements

object[] | null

The final computed features for the product pricing

Show child attributes

created_at

string<date-time>

The date the product pricing was created

currency

string

The currency for the product pricing

description

string

The description for the product pricing

external_name

string

The externally exposed name for the product pricing used on invoices

string

The ID of the product pricing in Maple

metadata

object

Any additional data as key-value pairs attached to the product pricing

name

string

The name of the product pricing

num_subs

integer

The number of subscriptions in the company with the product pricing

Required range: x >= 0

override_entitlements

object[] | null

The overridden features for the product pricing

Show child attributes

product_id

string

The product ID that the product pricing is attached to

state

string

The state of the product pricing such as ACTIVE or ARCHIVED

tags

string[] | null

Any tags on the product pricing

type

string

The type of product pricing such as recurring or one-time

updated_at

string<date-time>

The date the product pricing was last updated

Find Product PricingSearch for product pricing with given parameters

⌘I

Create Product Pricing

curl --request POST \
  --url https://api.maplebilling.com/api/v1/companies/{company_id}/pricing \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "base_price": {
    "currency": "<string>",
    "value_in_cents": 123
  },
  "base_units": 1,
  "billing_frequency": {
    "count": 123,
    "frequency": "HOUR"
  },
  "carryover": true,
  "charge_type": null,
  "credit_price": {
    "amount": {
      "currency": "<string>",
      "value_in_cents": 123
    },
    "item_id": null,
    "type": "AMOUNT",
    "units": 123
  },
  "currency": "<string>",
  "description": "<string>",
  "display_type": null,
  "entitlements": [
    {
      "entitlement_id": "<string>",
      "id": "<string>",
      "key": "<string>",
      "value": "<any>"
    }
  ],
  "external_name": "<string>",
  "fixed_price": {
    "price_per_unit": 123
  },
  "gradient_price": [
    {
      "end": 1,
      "flat_price": 123,
      "is_custom_tier": true,
      "price_per_unit": 123,
      "start": 1
    }
  ],
  "item_id": null,
  "metadata": {},
  "metric_id": null,
  "minimum_spend": {
    "currency": "<string>",
    "value_in_cents": 123
  },
  "minimum_spend_schedule": {
    "allow_pulling_forward": true,
    "amount_per_period": null,
    "minimum_spend_schedule_type": "<string>"
  },
  "name": "<string>",
  "pricing_type": "FIXED",
  "product_id": "<string>",
  "proration_type": null,
  "recognition_schedule": {
    "amount_per_period": null,
    "recognition_schedule_type": "<string>"
  },
  "scheduled_price": {
    "price_per_unit_per_period": [
      "<string>"
    ]
  },
  "step_price": {
    "price_per_step": 123,
    "step_size": 1
  },
  "tags": [
    "<string>"
  ],
  "true_up_frequency": "<string>",
  "type": "<string>",
  "volume_price": [
    {
      "flat_price": 123,
      "is_custom_tier": true,
      "price_per_unit": 123,
      "total_units_end": 1,
      "total_units_start": 1
    }
  ]
}'

{
  "company_id": "<string>",
  "computed_entitlements": [
    {
      "entitlement_id": "<string>",
      "id": "<string>",
      "inherited_from_id": null,
      "inherited_from_type": null,
      "key": "<string>",
      "name": "<string>",
      "original_value": "<any>",
      "overridden": null,
      "type": "<string>",
      "value": "<any>"
    }
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "currency": "<string>",
  "description": "<string>",
  "external_name": "<string>",
  "id": "<string>",
  "metadata": {},
  "name": "<string>",
  "num_subs": 1,
  "override_entitlements": [
    {
      "entitlement_id": "<string>",
      "id": "<string>",
      "inherited_from_id": null,
      "inherited_from_type": null,
      "key": "<string>",
      "name": "<string>",
      "original_value": "<any>",
      "overridden": null,
      "type": "<string>",
      "value": "<any>"
    }
  ],
  "product_id": "<string>",
  "state": "<string>",
  "tags": [
    "<string>"
  ],
  "type": "<string>",
  "updated_at": "2023-11-07T05:31:56Z"
}

API Features

API Reference

Webhook Reference

Authorizations

Headers

Path Parameters

Body

Response