API Reference
Webhook Reference
Find Subscriptions
Search subscriptions with given parameters
curl --request POST \
--url https://api.maplebilling.com/api/v1/companies/{company_id}/subscriptions/find \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"pagination": {
"from_key": "<unknown>",
"limit": 20
},
"sort_key": "createdAtDesc",
"include_meta": "<unknown>",
"query": {
"auto_charges": "<unknown>",
"auto_renews": "<unknown>",
"bundle_pricing_id": "<unknown>",
"customer_id": "<unknown>",
"end_date": {
"eq": "<unknown>",
"gte": "<unknown>",
"lt": "<unknown>",
"lte": "<unknown>"
},
"exclude_from_metrics": "<unknown>",
"group_id": "<unknown>",
"managed_externally": "<unknown>",
"mrr": {
"eq": "<unknown>",
"gt": "<unknown>",
"gte": "<unknown>",
"lte": "<unknown>"
},
"next_invoice_date": {
"eq": "<unknown>",
"gte": "<unknown>",
"lt": "<unknown>",
"lte": "<unknown>"
},
"owner_id": "<string>",
"owner_ids": {
"condition": "AND",
"values": [
"<string>"
]
},
"parent_billed": "<unknown>",
"parent_customer_id": "<string>",
"payment_method_id": "<unknown>",
"product_ids": {
"condition": "AND",
"values": [
"<string>"
]
},
"product_pricing_id": "<unknown>",
"product_pricing_ids": {
"condition": "AND",
"values": [
"<string>"
]
},
"product_pricing_tags": {
"condition": "AND",
"values": [
"<string>"
]
},
"product_tags": {
"condition": "AND",
"values": [
"<string>"
]
},
"renewal_date": {
"eq": "<unknown>",
"gte": "<unknown>",
"lt": "<unknown>",
"lte": "<unknown>"
},
"search": "<unknown>",
"start_date": {
"eq": "<unknown>",
"gte": "<unknown>",
"lt": "<unknown>",
"lte": "<unknown>"
},
"status": "ACTIVE",
"statuses": "ACTIVE",
"tags": {
"condition": "AND",
"values": [
"<string>"
]
},
"trial": "<unknown>"
}
}
'{
"pagination": {
"from_key": "<unknown>",
"limit": 123
},
"results": [
{
"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": "<string>"
},
"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": "<string>"
},
"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
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
The idempotency key that will be used to ensure the request is only performed once
Path Parameters
The company ID with the prefix 'cmp_'.
Body
createdAtDesc, createdAtAsc, updatedAtAsc, updatedAtDesc, mrrAsc, mrrDesc, startDateAsc, startDateDesc, nextInvoiceAsc, nextInvoiceDesc, renewalDateAsc, renewalDateDesc Whether to include additional metadata in the pagination response such the number of total results
The query criteria for the request
Show child attributes
Show child attributes
Whether subscriptions are automatically charged to the payment method
Whether subscriptions auto renew at the end of the term.
The bundle pricing ID that the subscription is tied to
The customer to which subscriptions belong
Filter based on next invoice date ranges in RFC-3339 format
Show child attributes
Show child attributes
Whether the subscription customer is excluded from metrics
The group id to get subscription ids (for filtered notification reminders)
Whether the subscription is managed customer outside of Maple
Filter based on next invoice date ranges in RFC-3339 format
Show child attributes
Show child attributes
Equal to the specific time
On or after the specific time
Before the specific time
On or before the specific time
Whether the subscription is billed to a parent customer
The parent customer to which subscriptions belong
The payment method the subscription method is attached to
The product pricing is part of the subscription
Filter based on renewal date ranges in RFC-3339 format
Show child attributes
Show child attributes
Any search string to match subscriptions
Filter based on start date ranges in RFC-3339 format
Show child attributes
Show child attributes
The specific status of the subscription can be one of ACTIVE, CANCELLED, PAUSED or UNPAID
ACTIVE, CANCELLED, PAUSED, UNPAID The statuses of the subscriptions can include ACTIVE, CANCELLED, PAUSED and UNPAID
Whether the subscription is currently in a trial
Response
OK
Show child attributes
Show child attributes
Whether the subscription is set up to automatically charge the card attached to the subscription or the default payment method on the customer
Whether the subscription is set up to automatically renew
The billing anchor date for this subscription, typically the same as the start date
Any cancel request information for this subscription
Show child attributes
Show child attributes
The date this subscription was cancelled. The end date represents the date that the subscription will actually cancel
Any change request information for this subscription
Show child attributes
Show child attributes
NEXT, IMMEDIATE, NONE IMMEDIATE, PERIOD_END, RENEWAL, CUSTOM, RELATIVE Show child attributes
Show child attributes
Show child attributes
Show child attributes
The term which includes a frequency interval and a count for number of intervals
Show child attributes
Show child attributes
The number of times the frequency elapses
The frequency at which the term repeats
HOUR, DAY, WEEK, BI_MONTH, MONTH, QUARTER, BI_ANNUAL, YEAR, ONETIME x >= 0Show child attributes
Show child attributes
Whether the pricing row will be hidden at checkout, defaults to false
The number of minimum units for this usage-based component
x >= 0The number of licenses for this license-based component
x >= 0The product metric pricing ID to which this config applies.
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
The sort index
Show child attributes
Show child attributes
DISCOUNT_AMOUNT, DISCOUNT_PERCENT 0 <= x <= 1ACTIVE, PENDING, REVOKED, EXPIRED, CONSUMED Show child attributes
Show child attributes
The quantity of the one-time charge
The custom pricing for the product. Either 'product_pricing_id' or 'custom_price' is required
Show child attributes
Show child attributes
The product ID
The description of the one-time charge
The product pricing for the one-time charge. Either 'product_pricing_id' or 'custom_price' is required
The sort index
The term which includes a frequency interval and a count for number of intervals
Show child attributes
Show child attributes
The term which includes a frequency interval and a count for number of intervals
The term which includes a frequency interval and a count for number of intervals
Show child attributes
Show child attributes
The date this subscription is due to change to a different plan
The company ID of the subscription
Computed entitlements attached to this subscription
Show child attributes
Show child attributes
The mapping of the quantities and the product metric pricings
Show child attributes
Show child attributes
Whether the pricing row will be hidden at checkout, defaults to false
The number of minimum units for this usage-based component
x >= 0The number of licenses for this license-based component
x >= 0The product metric pricing ID to which this config applies.
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
The sort index
The date the subscription was created
The expanded customer details for the subscription
Show child attributes
Show child attributes
The address of the customer
Show child attributes
Show child attributes
2-character country code (ISO 3166-1 alpha-2)
The additional emails to cc on customer's invoices
The company ID of the customer
The computed entitlements for the customer
Show child attributes
Show child attributes
The date the customer was created
The email of the customer
Whether to exclude this customer and related fields from any metrics in Maple
The ID of the customer in Maple
The unique identifier for the customer that ties back to your system. You can query for a customer using this identifier
The integration references of this customer in third-party applications connected to Maple
Show child attributes
Show child attributes
The locale of the customer
Whether this customer is managed outside of Maple
The metadata as key-value pairs attached to this customer
The name of the customer
The name of the company or the organization this customer is a part of
The company user ID of person in Maple assigned to manage this customer
The customer ID of the parent customer assigned in Maple
The phone number of the customer
The status of the customer such as ACTIVE or ARCHIVED
The title of the customer, such as CEO, VP
The date the customer was last updated
The customer to which this subscription belongs
The end date of the subscription, if there is one
The ID of the subscription in Maple
The number of days between the invoice date and the due date
x >= 0Any additional data as key-value pairs attached to the subscription
The date the next invoice for this subscription will be available
Any entitlements attached to this subscription
Show child attributes
Show child attributes
The date this subscription was paused for collection
The payment method for this subscription, if available
The list of plans that are part of this subscription along with the quantities and minimum purchased units per metric under the plan
The list of plans that are part of this subscription along with the quantities and minimum purchased units per metric under the plan
Show child attributes
Show child attributes
The date this product pricing was created
The currency for the product pricing
The externally exposed name for the product pricing
The ID of the product pricing
The name of the product pricing
The expanded product for the product pricing
Show child attributes
Show child attributes
The company ID of the product
The date the product was created
The description of the product
The entitlements that enable features for the product
Show child attributes
Show child attributes
The external name of the product
The ID of the product in Maple
The url for the image of the product
The date the product was created in the import source
The import reference ID for the product
Where the product is imported from
Any additional data as key-value pairs attached to the product
The name of the product
The product prices attached to this product
Show child attributes
Show child attributes
The company ID for the product pricing
The final computed features for the product pricing
Show child attributes
Show child attributes
The date the product pricing was created
The currency for the product pricing
The description for the product pricing
The externally exposed name for the product pricing used on invoices
The ID of the product pricing in Maple
The date the product pricing was created from the import source
The import reference of the product pricing
Where the product pricing was imported from
Any additional data as key-value pairs attached to the product pricing
The name of the product pricing
The number of subscriptions in the company with the product pricing
x >= 0The overridden features for the product pricing
Show child attributes
Show child attributes
The expanded product for the product pricing
Show child attributes
Show child attributes
The product ID that the product pricing is attached to
The metric components of the product pricing plan
Show child attributes
Show child attributes
Show child attributes
Show child attributes
The company ID for the billable item
The date the billable item was created
Any description attached to the billable item
The display type of the billable item which can be one of UNITS, AMOUNT, THOUSAND_UNITS, MILLION_UNITS
Whether the billable item can be further edited
The public name of the billable item
The ID of the billable item in Maple
The name of the billable item
Whether this is a standard billable item in Maple or a custom billable item
The type of the billable item which can be one of CUSTOM_USAGE or CUSTOM_OBJ, based on usage-based item or object-based item
The date the billable item was last updated
Show child attributes
Show child attributes
The amount which has value in cents and a currency
Show child attributes
Show child attributes
Show child attributes
Show child attributes
2-character country code (ISO 3166-1 alpha-2)
Show child attributes
Show child attributes
Type of credit
AMOUNT, UNITS Item ID of the credit
Units of credit
Show child attributes
Show child attributes
Show child attributes
Show child attributes
End quantity for the row
x >= 0Flat Price (in cents)
Is custom tier
Price per unit (in cents)
Start quantity for the row
x >= 0Show child attributes
Show child attributes
The company ID for the billable item
The date the billable item was created
Any description attached to the billable item
The display type of the billable item which can be one of UNITS, AMOUNT, THOUSAND_UNITS, MILLION_UNITS
Whether the billable item can be further edited
The public name of the billable item
The ID of the billable item in Maple
The name of the billable item
Whether this is a standard billable item in Maple or a custom billable item
The type of the billable item which can be one of CUSTOM_USAGE or CUSTOM_OBJ, based on usage-based item or object-based item
The date the billable item was last updated
The amount which has value in cents and a currency
Show child attributes
Show child attributes
Allow pulling forward of minimum spend
Amount of period per unit (in cents)
Type of minimum spend schedule
x >= 0Show child attributes
Show child attributes
Amount of period per unit (in cents)
Type of recognition schedule
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Flat Price (in cents)
Is custom tier
Price per unit (in cents)
End quantity for the row
x >= 0Start quantity for the row
x >= 0Show child attributes
Show child attributes
Show child attributes
Show child attributes
The state of the product pricing such as ACTIVE or ARCHIVED
Any tags on the product pricing
The type of product pricing such as recurring or one-time
The date the product pricing was last updated
The upsell product pricing ID
The state of the product such as ACTIVE or ARCHIVED
Any tags on the product
The date the product was last updated
The ID of the product
The metric components of the product pricing plan
Show child attributes
Show child attributes
The date this product metric pricing was created
The ID of the product metric pricing
The expanded billable item object
Show child attributes
Show child attributes
The company ID for the billable item
The date the billable item was created
Any description attached to the billable item
The display type of the billable item which can be one of UNITS, AMOUNT, THOUSAND_UNITS, MILLION_UNITS
Whether the billable item can be further edited
The public name of the billable item
The ID of the billable item in Maple
The name of the billable item
Whether this is a standard billable item in Maple or a custom billable item
The type of the billable item which can be one of CUSTOM_USAGE or CUSTOM_OBJ, based on usage-based item or object-based item
The date the billable item was last updated
The billable item ID
The expanded billable item pricing object
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
2-character country code (ISO 3166-1 alpha-2)
Show child attributes
Show child attributes
Type of credit
AMOUNT, UNITS Item ID of the credit
Units of credit
Show child attributes
Show child attributes
Show child attributes
Show child attributes
End quantity for the row
x >= 0Flat Price (in cents)
Is custom tier
Price per unit (in cents)
Start quantity for the row
x >= 0Show child attributes
Show child attributes
The company ID for the billable item
The date the billable item was created
Any description attached to the billable item
The display type of the billable item which can be one of UNITS, AMOUNT, THOUSAND_UNITS, MILLION_UNITS
Whether the billable item can be further edited
The public name of the billable item
The ID of the billable item in Maple
The name of the billable item
Whether this is a standard billable item in Maple or a custom billable item
The type of the billable item which can be one of CUSTOM_USAGE or CUSTOM_OBJ, based on usage-based item or object-based item
The date the billable item was last updated
Show child attributes
Show child attributes
Allow pulling forward of minimum spend
Amount of period per unit (in cents)
Type of minimum spend schedule
x >= 0Show child attributes
Show child attributes
Show child attributes
Show child attributes
Flat Price (in cents)
Is custom tier
Price per unit (in cents)
End quantity for the row
x >= 0Start quantity for the row
x >= 0The billable item pricing ID
The expanded billable metric object
Show child attributes
Show child attributes
Show child attributes
Show child attributes
The billable metric ID
The minimum units committed for this product metric pricing
The number of licenses for this product metric pricing
The date this product metric pricing was updated
Any tags on the product pricing
The type of product pricing such as recurring or one-time
The date this product pricing was updated
The renewal date of the subscription, if there is one
The start date of the subscription
The subscription status which can be one of active, cancelled or unpaid
The term for the subscription, broken into the intervals and the number of intervals
Whether the subscription is a trial
The date the trial converted to an active subscription, remains null if trial does not convert
The date the subscription was last updated
curl --request POST \
--url https://api.maplebilling.com/api/v1/companies/{company_id}/subscriptions/find \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"pagination": {
"from_key": "<unknown>",
"limit": 20
},
"sort_key": "createdAtDesc",
"include_meta": "<unknown>",
"query": {
"auto_charges": "<unknown>",
"auto_renews": "<unknown>",
"bundle_pricing_id": "<unknown>",
"customer_id": "<unknown>",
"end_date": {
"eq": "<unknown>",
"gte": "<unknown>",
"lt": "<unknown>",
"lte": "<unknown>"
},
"exclude_from_metrics": "<unknown>",
"group_id": "<unknown>",
"managed_externally": "<unknown>",
"mrr": {
"eq": "<unknown>",
"gt": "<unknown>",
"gte": "<unknown>",
"lte": "<unknown>"
},
"next_invoice_date": {
"eq": "<unknown>",
"gte": "<unknown>",
"lt": "<unknown>",
"lte": "<unknown>"
},
"owner_id": "<string>",
"owner_ids": {
"condition": "AND",
"values": [
"<string>"
]
},
"parent_billed": "<unknown>",
"parent_customer_id": "<string>",
"payment_method_id": "<unknown>",
"product_ids": {
"condition": "AND",
"values": [
"<string>"
]
},
"product_pricing_id": "<unknown>",
"product_pricing_ids": {
"condition": "AND",
"values": [
"<string>"
]
},
"product_pricing_tags": {
"condition": "AND",
"values": [
"<string>"
]
},
"product_tags": {
"condition": "AND",
"values": [
"<string>"
]
},
"renewal_date": {
"eq": "<unknown>",
"gte": "<unknown>",
"lt": "<unknown>",
"lte": "<unknown>"
},
"search": "<unknown>",
"start_date": {
"eq": "<unknown>",
"gte": "<unknown>",
"lt": "<unknown>",
"lte": "<unknown>"
},
"status": "ACTIVE",
"statuses": "ACTIVE",
"tags": {
"condition": "AND",
"values": [
"<string>"
]
},
"trial": "<unknown>"
}
}
'{
"pagination": {
"from_key": "<unknown>",
"limit": 123
},
"results": [
{
"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": "<string>"
},
"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": "<string>"
},
"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"
}
]
}