Skip to main content
PATCH
/
companies
/
{company_id}
/
subscriptions
/
{id}
Update Subscription
curl --request PATCH \
  --url https://api.maplebilling.com/api/v1/companies/{company_id}/subscriptions/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "auto_charges": "<unknown>",
  "invoice_additional_display_fields": "<unknown>",
  "invoice_due_date_from_creation": "<unknown>",
  "invoice_payment_instructions": "<string>",
  "metadata": {},
  "minimum_spend": {
    "currency": "<string>",
    "value_in_cents": 123
  },
  "override_entitlements": "<unknown>",
  "parent_billed": "<unknown>",
  "payment_method_id": "<string>",
  "tags": "<unknown>"
}
'
{
  "arr": {
    "currency": "<string>",
    "value_in_cents": 123
  },
  "auto_charges": true,
  "auto_renews": true,
  "billing_anchor_date": "2023-11-07T05:31:56Z",
  "cancel_config": {
    "campaign_id": "<string>",
    "campaign_step_id": "<string>",
    "charge_remaining_balance": "<unknown>",
    "custom_end_date": "<unknown>",
    "custom_refund_amount": {
      "currency": "<string>",
      "value_in_cents": 123
    },
    "reason": "<unknown>",
    "refund_type": "<string>",
    "send_customer_receipt": "<unknown>",
    "timing": "<string>"
  },
  "cancel_date": "<unknown>",
  "change_config": {
    "proration_type": "NEXT",
    "timing": "IMMEDIATE",
    "actual_change_time": "<unknown>",
    "auto_charges": "<unknown>",
    "bundle_pricing": {
      "bundle_product_pricings": [
        {
          "bundle_pricing_id": "<string>",
          "company_id": "<string>",
          "created_at": "2023-11-07T05:31:56Z",
          "deleted_at": {},
          "id": "<string>",
          "product_id": "<string>",
          "product_pricing_id": "<string>",
          "updated_at": "2023-11-07T05:31:56Z"
        }
      ],
      "company_id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "currency": "<string>",
      "default_term": {
        "count": 123,
        "frequency": "HOUR"
      },
      "deleted_at": {},
      "description": "<string>",
      "id": "<string>",
      "image_url": "<string>",
      "import_created_at_ref": "<unknown>",
      "import_ref": "<unknown>",
      "imported_from": "<unknown>",
      "is_auto_generated": true,
      "key": "<string>",
      "metadata": {},
      "name": "<string>",
      "num_subs": 1,
      "state": "<string>",
      "updated_at": "2023-11-07T05:31:56Z"
    },
    "bundle_pricing_id": "<unknown>",
    "config_items": [
      {
        "hide_at_checkout": "<unknown>",
        "minimum_units": 1,
        "num_licenses": 1,
        "product_metric_pricing_id": "<unknown>",
        "product_pricing_id": "<unknown>",
        "quantity_config": {
          "allow_custom_quantity": true,
          "max_quantity": 123,
          "min_quantity": 123
        },
        "sort_order": "<unknown>",
        "upsell_product_metric_pricing_id": "<unknown>"
      }
    ],
    "custom_change_date": "<unknown>",
    "discounts": "<unknown>",
    "metadata": {},
    "minimum_spend": {
      "currency": "<string>",
      "value_in_cents": 123
    },
    "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>"
      }
    ],
    "payment_method_id": "<unknown>",
    "product_pricing_ids": [
      "<string>"
    ],
    "relative_term": {
      "count": 123,
      "frequency": "HOUR"
    },
    "reset_billing_anchor": "<unknown>",
    "term": {
      "count": 123,
      "frequency": "HOUR"
    },
    "trial": "<unknown>",
    "trial_term": {
      "count": 123,
      "frequency": "HOUR"
    }
  },
  "change_date": "<unknown>",
  "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>"
    }
  ],
  "config_items": [
    {
      "hide_at_checkout": "<unknown>",
      "minimum_units": 1,
      "num_licenses": 1,
      "product_metric_pricing_id": "<unknown>",
      "product_pricing_id": "<unknown>",
      "quantity_config": {
        "allow_custom_quantity": true,
        "max_quantity": 123,
        "min_quantity": 123
      },
      "sort_order": "<unknown>",
      "upsell_product_metric_pricing_id": "<unknown>"
    }
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "customer": {
    "address": {
      "address_line_1": "<string>",
      "address_line_2": "<string>",
      "city": "<string>",
      "country": "<string>",
      "place_id": "<unknown>",
      "state": "<string>",
      "zip": "<string>"
    },
    "arr": {
      "currency": "<string>",
      "value_in_cents": 123
    },
    "billing_emails": [
      "<string>"
    ],
    "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",
    "customer_integration_metadata": {},
    "email": "<string>",
    "exclude_from_metrics": true,
    "id": "<string>",
    "identifier": "<string>",
    "integration_references": [
      {
        "integration_icon": "<string>",
        "integration_id": "<string>",
        "integration_key": "<string>",
        "integration_name": "<string>",
        "reference_type": "<string>",
        "remote_id": "<string>",
        "remote_type": "<string>"
      }
    ],
    "locale": "<string>",
    "managed_externally": true,
    "metadata": {},
    "mrr": {
      "currency": "<string>",
      "value_in_cents": 123
    },
    "name": "<string>",
    "org_name": "<string>",
    "owner_id": "<unknown>",
    "parent_customer_id": "<unknown>",
    "phone": "<string>",
    "status": "<string>",
    "title": "<string>",
    "updated_at": "2023-11-07T05:31:56Z"
  },
  "customer_id": "<string>",
  "end_date": "<unknown>",
  "id": "<string>",
  "invoice_additional_display_fields": [
    {
      "name": "<string>",
      "value": "<string>"
    }
  ],
  "invoice_due_date_from_creation": 1,
  "metadata": {},
  "minimum_spend": {
    "currency": "<string>",
    "value_in_cents": 123
  },
  "mrr": {
    "currency": "<string>",
    "value_in_cents": 123
  },
  "next_invoice_date": "<unknown>",
  "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>"
    }
  ],
  "pause_config": {
    "behavior": "<string>",
    "resume_date": "<unknown>"
  },
  "pause_date": "<unknown>",
  "payment_method_id": "<unknown>",
  "product_pricing_ids": [
    "<string>"
  ],
  "product_pricings": [
    {
      "created_at": "2023-11-07T05:31:56Z",
      "currency": "<string>",
      "external_name": "<string>",
      "id": "<string>",
      "name": "<string>",
      "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": [
          {
            "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": "<unknown>",
            "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>"
          }
        ],
        "state": "<string>",
        "tags": [
          "<string>"
        ],
        "updated_at": "2023-11-07T05:31:56Z"
      },
      "product_id": "<string>",
      "product_metric_pricings": [
        {
          "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>",
          "minimum_units": 123,
          "num_licenses": 123,
          "updated_at": "2023-11-07T05:31:56Z"
        }
      ],
      "tags": [
        "<string>"
      ],
      "type": "<string>",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "renewal_date": "<unknown>",
  "start_date": "2023-11-07T05:31:56Z",
  "status": "<string>",
  "term": {
    "count": 123,
    "frequency": "HOUR"
  },
  "trial": true,
  "trial_conversion_date": "<unknown>",
  "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_'.

​
id
string
required

The resource ID

Body

application/json

The update configuration for subscription's properties'

​
auto_charges
null | boolean

Whether the subscription is automatically charged to the payment method

​
invoice_additional_display_fields
null | object[]

Any additional invoice key-value pairs that attached to the invoices for this subscription

​
invoice_due_date_from_creation
null | integer

The number of days between the invoice date and the due date for any invoices created for this subscription

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

HTML formatted payment instructions attached to each invoice generated for the subscription. If non-null, overrides the invoice payment instructions set at the company-wide setting.

​
metadata
object

Any additional data as key-value pairs that needs to be attached to the subscription

​
minimum_spend
object

The minimum amount of spend that needs to be attached to the subscription

​
override_entitlements
null | object[]

The entitlements that will override product and product pricing entitlements

​
parent_billed
null | boolean

Whether the subscription is billed to a parent customer

​
payment_method_id
string | null

The payment method for the subscription on change

​
tags
null | string[]

Any tags that needs to be attached to the subscription

Response

200 - application/json

OK

​
arr
object

The annual recurring revenue for this subscription

​
auto_charges
boolean

Whether the subscription is set up to automatically charge the card attached to the subscription or the default payment method on the customer

​
auto_renews
boolean

Whether the subscription is set up to automatically renew

​
billing_anchor_date
string<date-time>

The billing anchor date for this subscription, typically the same as the start date

​
cancel_config
object

Any cancel request information for this subscription

​
cancel_date
null | string<date-time>

The date this subscription was cancelled. The end date represents the date that the subscription will actually cancel

​
change_config
object

Any change request information for this subscription

​
change_date
null | string<date-time>

The date this subscription is due to change to a different plan

​
company_id
string

The company ID of the subscription

​
computed_entitlements
object[] | null

Computed entitlements attached to this subscription

​
config_items
object[] | null

The mapping of the quantities and the product metric pricings

​
created_at
string<date-time>

The date the subscription was created

​
customer
object

The expanded customer details for the subscription

​
customer_id
string

The customer to which this subscription belongs

​
end_date
null | string<date-time>

The end date of the subscription, if there is one

​
id
string

The ID of the subscription in Maple

​
invoice_additional_display_fields
object[] | null

Any additional invoice key-value pairs that attached to the invoices for this subscription

​
invoice_due_date_from_creation
integer

The number of days between the invoice date and the due date

Required range: x >= 0
​
metadata
object

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

​
minimum_spend
object

The minimum spend for this subscription per billing period

​
mrr
object

The monthly recurring revenue for this subscription

​
next_invoice_date
null | string<date-time>

The date the next invoice for this subscription will be available

​
override_entitlements
object[] | null

Any entitlements attached to this subscription

​
pause_config
object

Any pause request information for this subscription

​
pause_date
null | string<date-time>

The date this subscription was paused for collection

​
payment_method_id
null | string

The payment method for this subscription, if available

​
product_pricing_ids
string[] | null

The list of plans that are part of this subscription along with the quantities and minimum purchased units per metric under the plan

​
product_pricings
object[] | null

The list of plans that are part of this subscription along with the quantities and minimum purchased units per metric under the plan

​
renewal_date
null | string<date-time>

The renewal date of the subscription, if there is one

​
start_date
string<date-time>

The start date of the subscription

​
status
string

The subscription status which can be one of active, cancelled or unpaid

​
term
object

The term for the subscription, broken into the intervals and the number of intervals

​
trial
boolean

Whether the subscription is a trial

​
trial_conversion_date
null | string<date-time>

The date the trial converted to an active subscription, remains null if trial does not convert

​
updated_at
string<date-time>

The date the subscription was last updated