subscription.default_usage_threshold_exceeded

Body

application/json

arr

object

The annual recurring revenue for this subscription

Show child attributes

arr.currency

string

arr.value_in_cents

integer

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

bundle_pricing_id

string

The bundle of product pricings attached to 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_date

null | string<date-time>

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

computed_entitlements

object[] | null

Computed entitlements attached to this subscription

Show child attributes

computed_entitlements.entitlement_id

string

computed_entitlements.id

string

computed_entitlements.inherited_from_id

null | string

computed_entitlements.inherited_from_type

null | string

computed_entitlements.key

string

computed_entitlements.name

string

computed_entitlements.original_value

any

computed_entitlements.overridden

null | boolean

computed_entitlements.type

string

computed_entitlements.value

any

config_items

object[] | null

The mapping of the quantities and the product metric pricings

Show child attributes

config_items.hide_at_checkout

null | boolean

Whether the pricing row will be hidden at checkout, defaults to false

config_items.minimum_units

number

The number of minimum units for this usage-based component

config_items.num_licenses

number

The number of licenses for this license-based component

config_items.product_metric_pricing_id

null | string

The product metric pricing ID to which this config applies.

config_items.product_pricing_id

null | string

The product pricing ID to which this config applies. If the product pricing contains multiple components, the same config will apply to all of them

config_items.quantity_config

object

Show child attributes

config_items.quantity_config.allow_custom_quantity

boolean

config_items.quantity_config.max_quantity

integer

config_items.quantity_config.min_quantity

integer

config_items.sort_order

null | number

The sort index

config_items.upsell_product_metric_pricing_id

null | string

created_at

string<date-time>

The date the subscription was created

customer

object

The expanded customer details for the subscription

Show child attributes

customer.email

string

The email of the customer

customer.exclude_from_metrics

boolean

Whether to exclude this customer and related fields from any metrics in Maple

customer.id

string

The ID of the customer in Maple

customer.identifier

string

The unique identifier for the customer that ties back to your system. You can query for a customer using this identifier

customer.managed_externally

boolean

Whether this customer is managed outside of Maple

customer.metadata

integer[] | null

The metadata as key-value pairs attached to this customer

Required range: x >= 0

customer.name

string

The name of the customer

customer.org_name

string

The name of the company or the organization this customer is a part of

customer.owner_id

null | string

The company user ID of person in Maple assigned to manage this customer

customer.parent_customer_id

null | string

The customer ID of the parent customer assigned in Maple

customer.status

string

The status of the customer such as ACTIVE or ARCHIVED

customer.title

string

The title of the customer, such as CEO, VP

customer_cancel_reason

null | string

An optional reason provided by the customer for the cancellation

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

string

The ID of the subscription in Maple

import_created_at_ref

null | string<date-time>

The date the subscription was created in the import source

import_ref

null | string

The reference ID in the provider that this subscription maps to

imported_from

null | string

The provider from which this subscription was imported

invoice_additional_display_fields

object[] | null

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

Show child attributes

invoice_additional_display_fields.name

string

invoice_additional_display_fields.value

string

invoice_due_date_from_creation

integer

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

Required range: x >= 0

invoice_event_grace_period

integer

The grace period (in seconds) for post charge events to be captured before invoice is generated

Required range: x >= 0

metadata

integer[] | null

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

Required range: x >= 0

minimum_spend

object

The minimum spend for this subscription per billing period

Show child attributes

minimum_spend.currency

string

minimum_spend.value_in_cents

integer

mrr

object

The monthly recurring revenue for this subscription

Show child attributes

mrr.currency

string

mrr.value_in_cents

integer

next_invoice_date

null | string<date-time>

The date the next invoice for this subscription will be available

parent_billed

boolean

Whether the subscription is billed to the parent of this customer

parent_customer

object

The parent customer for this subscription

Show child attributes

parent_customer.email

string

The email of the customer

parent_customer.exclude_from_metrics

boolean

Whether to exclude this customer and related fields from any metrics in Maple

parent_customer.id

string

The ID of the customer in Maple

parent_customer.identifier

string

The unique identifier for the customer that ties back to your system. You can query for a customer using this identifier

parent_customer.managed_externally

boolean

Whether this customer is managed outside of Maple

parent_customer.metadata

integer[] | null

The metadata as key-value pairs attached to this customer

Required range: x >= 0

parent_customer.name

string

The name of the customer

parent_customer.org_name

string

The name of the company or the organization this customer is a part of

parent_customer.owner_id

null | string

The company user ID of person in Maple assigned to manage this customer

parent_customer.parent_customer_id

null | string

The customer ID of the parent customer assigned in Maple

parent_customer.status

string

The status of the customer such as ACTIVE or ARCHIVED

parent_customer.title

string

The title of the customer, such as CEO, VP

parent_customer_id

null | string

The parent customer to which this subscription could be billed to

pause_date

null | string<date-time>

The date this subscription was paused for collection

payment_method_id

null | string

deprecated

The payment method for this subscription, if available. Use 'paymentMethod' instead

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

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

Response

200

Return a 200 status to indicate that the data was received successfully

API Features

API Reference

Webhook Reference

subscription.default_usage_threshold_exceeded

Body

Response