GET
/
companies
/
{company_id}
/
checkout
/
{id}
curl --request GET \
  --url https://api.maplebilling.com/api/v1/companies/{company_id}/checkout/{id} \
  --header 'Authorization: Bearer <token>'
{
  "acv": {
    "currency": "<string>",
    "value_in_cents": 123
  },
  "auto_charges": true,
  "auto_renews": true,
  "bundle_pricing": {
    "bundle_product_pricings": [
      {
        "bundle_pricing_id": "<string>",
        "company_id": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "id": "<string>",
        "product": {
          "company_id": "<string>",
          "created_at": "2023-11-07T05:31:56Z",
          "description": "<string>",
          "entitlements": [
            {
              "entitlement_id": "<string>",
              "inherited_from_id": "<string>",
              "inherited_from_type": "<string>",
              "key": "<string>",
              "name": "<string>",
              "original_value": "<any>",
              "overridden": true,
              "type": "<string>",
              "value": "<any>"
            }
          ],
          "external_name": "<string>",
          "id": "<string>",
          "image_url": "<string>",
          "import_created_at_ref": "2023-11-07T05:31:56Z",
          "import_ref": "<string>",
          "imported_from": "<string>",
          "metadata": {},
          "name": "<string>",
          "product_pricings": [
            {
              "company_id": "<string>",
              "computed_entitlements": [
                {
                  "entitlement_id": "<string>",
                  "inherited_from_id": "<string>",
                  "inherited_from_type": "<string>",
                  "key": "<string>",
                  "name": "<string>",
                  "original_value": "<any>",
                  "overridden": true,
                  "type": "<string>",
                  "value": "<any>"
                }
              ],
              "created_at": "2023-11-07T05:31:56Z",
              "currency": "<string>",
              "description": "<string>",
              "external_name": "<string>",
              "id": "<string>",
              "import_created_at_ref": "2023-11-07T05:31:56Z",
              "import_ref": "<string>",
              "imported_from": "<string>",
              "metadata": {},
              "name": "<string>",
              "num_subs": 1,
              "override_entitlements": [
                {
                  "entitlement_id": "<string>",
                  "inherited_from_id": "<string>",
                  "inherited_from_type": "<string>",
                  "key": "<string>",
                  "name": "<string>",
                  "original_value": "<any>",
                  "overridden": true,
                  "type": "<string>",
                  "value": "<any>"
                }
              ],
              "product": {},
              "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": "<string>",
                        "state": "<string>",
                        "zip": "<string>"
                      },
                      "computed_entitlements": {},
                      "created_at": "2023-11-07T05:31:56Z",
                      "customer_id": "<string>",
                      "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": {
                      "amount": {
                        "currency": "<string>",
                        "value_in_cents": 123
                      },
                      "item_id": "<string>",
                      "type": "AMOUNT",
                      "units": 2
                    },
                    "custom_price": {
                      "max_price_per_unit": "<string>",
                      "min_price_per_unit": "<string>",
                      "preset_price_per_unit": "<string>",
                      "price_per_unit": "<string>"
                    },
                    "description": "<string>",
                    "display_type": "<string>",
                    "editable": true,
                    "external_name": "<string>",
                    "fixed_price": {
                      "price_per_unit": "<string>"
                    },
                    "frequency": "<string>",
                    "gradient_price": [
                      {
                        "end": 1,
                        "flat_price": "<string>",
                        "is_custom_tier": true,
                        "price_per_unit": "<string>",
                        "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": [
                        "<string>"
                      ],
                      "minimum_spend_schedule_type": "<string>"
                    },
                    "name": "<string>",
                    "num_subs": 1,
                    "proration_type": "<string>",
                    "recognition_schedule": {
                      "amount_per_period": [
                        "<string>"
                      ],
                      "recognition_schedule_type": "<string>"
                    },
                    "scheduled_price": {
                      "price_per_unit_per_period": [
                        "<string>"
                      ]
                    },
                    "state": "<string>",
                    "step_price": {
                      "price_per_step": "<string>",
                      "step_size": 1
                    },
                    "term_count": 123,
                    "true_up_frequency": "<string>",
                    "type": "<string>",
                    "updated_at": "2023-11-07T05:31:56Z",
                    "volume_price": [
                      {
                        "flat_price": "<string>",
                        "is_custom_tier": true,
                        "price_per_unit": "<string>",
                        "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": "<string>"
                    },
                    "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": "<string>"
            }
          ],
          "state": "<string>",
          "tags": [
            "<string>"
          ],
          "updated_at": "2023-11-07T05:31:56Z"
        },
        "product_id": "<string>",
        "product_pricing": {
          "company_id": "<string>",
          "computed_entitlements": [
            {
              "entitlement_id": "<string>",
              "inherited_from_id": "<string>",
              "inherited_from_type": "<string>",
              "key": "<string>",
              "name": "<string>",
              "original_value": "<any>",
              "overridden": true,
              "type": "<string>",
              "value": "<any>"
            }
          ],
          "created_at": "2023-11-07T05:31:56Z",
          "currency": "<string>",
          "description": "<string>",
          "external_name": "<string>",
          "id": "<string>",
          "import_created_at_ref": "2023-11-07T05:31:56Z",
          "import_ref": "<string>",
          "imported_from": "<string>",
          "metadata": {},
          "name": "<string>",
          "num_subs": 1,
          "override_entitlements": [
            {
              "entitlement_id": "<string>",
              "inherited_from_id": "<string>",
              "inherited_from_type": "<string>",
              "key": "<string>",
              "name": "<string>",
              "original_value": "<any>",
              "overridden": true,
              "type": "<string>",
              "value": "<any>"
            }
          ],
          "product": {},
          "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": "<string>",
                    "state": "<string>",
                    "zip": "<string>"
                  },
                  "computed_entitlements": {},
                  "created_at": "2023-11-07T05:31:56Z",
                  "customer_id": "<string>",
                  "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": {
                  "amount": {
                    "currency": "<string>",
                    "value_in_cents": 123
                  },
                  "item_id": "<string>",
                  "type": "AMOUNT",
                  "units": 2
                },
                "custom_price": {
                  "max_price_per_unit": "<string>",
                  "min_price_per_unit": "<string>",
                  "preset_price_per_unit": "<string>",
                  "price_per_unit": "<string>"
                },
                "description": "<string>",
                "display_type": "<string>",
                "editable": true,
                "external_name": "<string>",
                "fixed_price": {
                  "price_per_unit": "<string>"
                },
                "frequency": "<string>",
                "gradient_price": [
                  {
                    "end": 1,
                    "flat_price": "<string>",
                    "is_custom_tier": true,
                    "price_per_unit": "<string>",
                    "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": [
                    "<string>"
                  ],
                  "minimum_spend_schedule_type": "<string>"
                },
                "name": "<string>",
                "num_subs": 1,
                "proration_type": "<string>",
                "recognition_schedule": {
                  "amount_per_period": [
                    "<string>"
                  ],
                  "recognition_schedule_type": "<string>"
                },
                "scheduled_price": {
                  "price_per_unit_per_period": [
                    "<string>"
                  ]
                },
                "state": "<string>",
                "step_price": {
                  "price_per_step": "<string>",
                  "step_size": 1
                },
                "term_count": 123,
                "true_up_frequency": "<string>",
                "type": "<string>",
                "updated_at": "2023-11-07T05:31:56Z",
                "volume_price": [
                  {
                    "flat_price": "<string>",
                    "is_custom_tier": true,
                    "price_per_unit": "<string>",
                    "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": "<string>"
                },
                "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": "<string>"
        },
        "product_pricing_id": "<string>",
        "updated_at": "2023-11-07T05:31:56Z"
      }
    ],
    "company_id": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "currency": "<string>",
    "description": "<string>",
    "id": "<string>",
    "is_auto_generated": true,
    "metadata": {},
    "name": "<string>",
    "num_subs": 1,
    "state": "<string>",
    "term": {
      "count": 2,
      "frequency": "HOUR"
    },
    "updated_at": "2023-11-07T05:31:56Z"
  },
  "bundle_pricing_id": "<string>",
  "campaigns": [
    {
      "amount": {
        "currency": "<string>",
        "value_in_cents": 123
      },
      "created_at": "2023-11-07T05:31:56Z",
      "current_step": 1,
      "customer": {
        "email": "<string>",
        "id": "<string>",
        "name": "<string>",
        "org_name": "<string>"
      },
      "id": "<string>",
      "invoice": {
        "auto_charges": true,
        "billed_customer_id": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "currency": "<string>",
        "customer_id": "<string>",
        "due": {
          "currency": "<string>",
          "value_in_cents": 123
        },
        "due_date": "2023-11-07T05:31:56Z",
        "hosted_link": "<string>",
        "invoice_date": "2023-11-07T05:31:56Z",
        "name": "<string>",
        "number": "<string>",
        "paid": {
          "currency": "<string>",
          "value_in_cents": 123
        },
        "paid_date": "2023-11-07T05:31:56Z",
        "pdf_link": "<string>",
        "prorated_amount": {
          "currency": "<string>",
          "value_in_cents": 123
        },
        "status": "<string>",
        "sub_total": {
          "currency": "<string>",
          "value_in_cents": 123
        },
        "subscription_id": "<string>",
        "total": {
          "currency": "<string>",
          "value_in_cents": 123
        },
        "updated_at": "2023-11-07T05:31:56Z",
        "uuid": "<string>"
      },
      "next_action_in": "2023-11-07T05:31:56Z",
      "next_action_type": "<string>",
      "proposal": {},
      "status": "<string>",
      "steps": [
        {
          "action_type": "<string>",
          "completed_at": "2023-11-07T05:31:56Z",
          "enqueued_at": "2023-11-07T05:31:56Z",
          "id": "<string>",
          "notification_log": {
            "cc": [
              "<string>"
            ],
            "id": "<string>",
            "notification_type": "<string>",
            "status": "<string>",
            "subject": "<string>",
            "to": "<string>"
          },
          "payment_transaction": {
            "created_at": "2023-11-07T05:31:56Z",
            "id": "<string>",
            "provider_type": "<string>",
            "status": "<string>",
            "total_amount": {
              "currency": "<string>",
              "value_in_cents": 123
            },
            "total_amount_default_currency": {
              "currency": "<string>",
              "value_in_cents": 123
            },
            "transaction_type": "<string>",
            "updated_at": "2023-11-07T05:31:56Z"
          },
          "status": "<string>",
          "step_number": 1
        }
      ],
      "time_from_reference_data": "2023-11-07T05:31:56Z",
      "total_steps": 1,
      "type": "<string>",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "change_custom_date": "2023-11-07T05:31:56Z",
  "change_proration_type": "<string>",
  "change_reset_billing_anchor": true,
  "change_timing": "<string>",
  "company": {
    "address": {
      "address_line_1": "<string>",
      "address_line_2": "<string>",
      "city": "<string>",
      "country": "<string>",
      "place_id": "<string>",
      "state": "<string>",
      "zip": "<string>"
    },
    "computed_entitlements": {},
    "created_at": "2023-11-07T05:31:56Z",
    "customer_id": "<string>",
    "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>",
  "completed_date": "2023-11-07T05:31:56Z",
  "config_items": [
    {
      "minimum_units": 1,
      "num_licenses": 1,
      "product_metric_pricing_id": "<string>",
      "product_pricing_id": "<string>",
      "quantity_config": {
        "allow_custom_quantity": true,
        "max_quantity": 123,
        "min_quantity": 123
      },
      "upsell_product_metric_pricing_id": "<string>"
    }
  ],
  "content": "<string>",
  "content_template": "<string>",
  "contract_attachments": [
    {
      "created_at": "2023-11-07T05:31:56Z",
      "file_id": "<string>",
      "id": "<string>",
      "original_filename": "<string>",
      "uploaded_at": "2023-11-07T05:31:56Z"
    }
  ],
  "counter_signatories": [
    {
      "company_user": {
        "created_at": "2023-11-07T05:31:56Z",
        "id": "<string>",
        "image_url": "<string>",
        "title": "<string>",
        "updated_at": "2023-11-07T05:31:56Z",
        "user": {
          "email": "<string>",
          "id": "<string>",
          "name": "<string>",
          "verified": true
        }
      },
      "declined": true,
      "email": "<string>",
      "id": "<string>",
      "position": 123,
      "signature_id": "<string>",
      "signed": true,
      "signed_date": "2023-11-07T05:31:56Z"
    }
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "custom_variables": {},
  "customer": {
    "address": {
      "address_line_1": "<string>",
      "address_line_2": "<string>",
      "city": "<string>",
      "country": "<string>",
      "place_id": "<string>",
      "state": "<string>",
      "zip": "<string>"
    },
    "email": "<string>",
    "id": "<string>",
    "identifier": "<string>",
    "name": "<string>",
    "org_name": "<string>",
    "parent_customer": {},
    "parent_customer_id": "<string>"
  },
  "customer_id": "<string>",
  "discounts": [
    {
      "amount": {
        "currency": "<string>",
        "value_in_cents": 123
      },
      "cap": {
        "currency": "<string>",
        "value_in_cents": 123
      },
      "company_id": "<string>",
      "coupon_id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "customer_id": "<string>",
      "deleted_at": {},
      "expiration_date": "2023-11-07T05:31:56Z",
      "id": "<string>",
      "import_created_at_ref": "2023-11-07T05:31:56Z",
      "import_ref": "<string>",
      "imported_from": "<string>",
      "item_pricing_id": "<string>",
      "name": "<string>",
      "onetime_billable": {
        "aggregate": 123,
        "company_id": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "custom_price": {
          "amount": {
            "currency": "<string>",
            "value_in_cents": 123
          },
          "description": "<string>",
          "product_id": "<string>"
        },
        "customer_id": "<string>",
        "deleted_at": {},
        "id": "<string>",
        "import_ref": "<string>",
        "imported_from": "<string>",
        "name": "<string>",
        "product_pricing_id": "<string>",
        "proposal_id": "<string>",
        "quantity_config": {
          "allow_custom_quantity": true,
          "max_quantity": 123,
          "min_quantity": 123
        },
        "state": "<string>",
        "type": "<string>",
        "updated_at": "2023-11-07T05:31:56Z"
      },
      "onetime_billable_id": "<string>",
      "percent": 123,
      "product_id": "<string>",
      "product_pricing_id": "<string>",
      "proposal_id": "<string>",
      "state": "<string>",
      "subscription_id": "<string>",
      "type": "<string>",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "expiration_date": "2023-11-07T05:31:56Z",
  "finalized_date": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "invoice_due_date_from_creation": 1,
  "invoice_event_grace_period": 1,
  "invoice_payment_instructions": "<string>",
  "metadata": {},
  "minimum_spend": {
    "currency": "<string>",
    "value_in_cents": 123
  },
  "one_time_billables": [
    {
      "aggregate": 123,
      "company_id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "custom_price": {
        "amount": {
          "currency": "<string>",
          "value_in_cents": 123
        },
        "description": "<string>",
        "product_id": "<string>"
      },
      "customer_id": "<string>",
      "id": "<string>",
      "name": "<string>",
      "product_pricing": {
        "company_id": "<string>",
        "computed_entitlements": [
          {
            "entitlement_id": "<string>",
            "inherited_from_id": "<string>",
            "inherited_from_type": "<string>",
            "key": "<string>",
            "name": "<string>",
            "original_value": "<any>",
            "overridden": true,
            "type": "<string>",
            "value": "<any>"
          }
        ],
        "created_at": "2023-11-07T05:31:56Z",
        "currency": "<string>",
        "description": "<string>",
        "external_name": "<string>",
        "id": "<string>",
        "import_created_at_ref": "2023-11-07T05:31:56Z",
        "import_ref": "<string>",
        "imported_from": "<string>",
        "metadata": {},
        "name": "<string>",
        "num_subs": 1,
        "override_entitlements": [
          {
            "entitlement_id": "<string>",
            "inherited_from_id": "<string>",
            "inherited_from_type": "<string>",
            "key": "<string>",
            "name": "<string>",
            "original_value": "<any>",
            "overridden": true,
            "type": "<string>",
            "value": "<any>"
          }
        ],
        "product": {},
        "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": "<string>",
                  "state": "<string>",
                  "zip": "<string>"
                },
                "computed_entitlements": {},
                "created_at": "2023-11-07T05:31:56Z",
                "customer_id": "<string>",
                "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": {
                "amount": {
                  "currency": "<string>",
                  "value_in_cents": 123
                },
                "item_id": "<string>",
                "type": "AMOUNT",
                "units": 2
              },
              "custom_price": {
                "max_price_per_unit": "<string>",
                "min_price_per_unit": "<string>",
                "preset_price_per_unit": "<string>",
                "price_per_unit": "<string>"
              },
              "description": "<string>",
              "display_type": "<string>",
              "editable": true,
              "external_name": "<string>",
              "fixed_price": {
                "price_per_unit": "<string>"
              },
              "frequency": "<string>",
              "gradient_price": [
                {
                  "end": 1,
                  "flat_price": "<string>",
                  "is_custom_tier": true,
                  "price_per_unit": "<string>",
                  "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": [
                  "<string>"
                ],
                "minimum_spend_schedule_type": "<string>"
              },
              "name": "<string>",
              "num_subs": 1,
              "proration_type": "<string>",
              "recognition_schedule": {
                "amount_per_period": [
                  "<string>"
                ],
                "recognition_schedule_type": "<string>"
              },
              "scheduled_price": {
                "price_per_unit_per_period": [
                  "<string>"
                ]
              },
              "state": "<string>",
              "step_price": {
                "price_per_step": "<string>",
                "step_size": 1
              },
              "term_count": 123,
              "true_up_frequency": "<string>",
              "type": "<string>",
              "updated_at": "2023-11-07T05:31:56Z",
              "volume_price": [
                {
                  "flat_price": "<string>",
                  "is_custom_tier": true,
                  "price_per_unit": "<string>",
                  "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": "<string>"
              },
              "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": "<string>"
      },
      "product_pricing_id": "<string>",
      "quantity_config": {
        "allow_custom_quantity": true,
        "max_quantity": 123,
        "min_quantity": 123
      },
      "state": "<string>",
      "type": "<string>",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "options": {
    "allow_promo_code": true,
    "collect_taxes": true,
    "completion_action": "<string>",
    "confirmation_message": "<string>",
    "redirect_url": "<string>",
    "requires_customer_address": true,
    "requires_customer_confirmation": true,
    "requires_customer_phone": true,
    "requires_email_verification": true,
    "save_card_on_checkout": true
  },
  "owner": {
    "created_at": "2023-11-07T05:31:56Z",
    "id": "<string>",
    "image_url": "<string>",
    "title": "<string>",
    "updated_at": "2023-11-07T05:31:56Z",
    "user": {
      "email": "<string>",
      "id": "<string>",
      "name": "<string>",
      "verified": true
    }
  },
  "owner_id": "<string>",
  "parent_billed": true,
  "payment_config": {
    "account_id": "<string>",
    "client_secret": "<string>",
    "integration_id": "<string>",
    "live_mode": true,
    "provider": "<string>",
    "razorpay": {
      "account_id": "<string>"
    },
    "stripe": {
      "account_id": "<string>"
    }
  },
  "payment_data": {
    "authorize_net": {
      "payment_method_id": "<string>"
    },
    "helcim": {
      "card_token": "<string>",
      "payment_method_id": "<string>"
    },
    "payment_provider_key": "stripe",
    "razor_pay": {
      "token_id": "<string>"
    },
    "stripe": {
      "payment_method_id": "<string>"
    }
  },
  "payment_provided_date": "2023-11-07T05:31:56Z",
  "po_number": "<string>",
  "previous_subscription": {
    "id": "<string>"
  },
  "previous_subscription_id": "<string>",
  "require_payment_method": true,
  "requires_customer_confirmation": true,
  "scheduled_changes": [
    {
      "actual_change_time": "2023-11-07T05:31:56Z",
      "auto_charges": true,
      "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": 2,
          "frequency": "HOUR"
        },
        "deleted_at": {},
        "description": "<string>",
        "id": "<string>",
        "image_url": "<string>",
        "import_created_at_ref": "2023-11-07T05:31:56Z",
        "import_ref": "<string>",
        "imported_from": "<string>",
        "is_auto_generated": true,
        "key": "<string>",
        "metadata": {},
        "name": "<string>",
        "num_subs": 1,
        "state": "<string>",
        "updated_at": "2023-11-07T05:31:56Z"
      },
      "bundle_pricing_id": "<string>",
      "config_items": [
        {
          "minimum_units": 1,
          "num_licenses": 1,
          "product_metric_pricing_id": "<string>",
          "product_pricing_id": "<string>",
          "quantity_config": {
            "allow_custom_quantity": true,
            "max_quantity": 123,
            "min_quantity": 123
          },
          "upsell_product_metric_pricing_id": "<string>"
        }
      ],
      "custom_change_date": "2023-11-07T05:31:56Z",
      "discounts": [
        {
          "amount": {
            "currency": "<string>",
            "value_in_cents": 123
          },
          "cap": {
            "currency": "<string>",
            "value_in_cents": 123
          },
          "coupon_id": "<string>",
          "customer_id": "<string>",
          "expiration_date": "2023-11-07T05:31:56Z",
          "import_created_at_ref": "2023-11-07T05:31:56Z",
          "import_ref": "<string>",
          "imported_from": "<string>",
          "item_pricing_id": "<string>",
          "name": "<string>",
          "onetime_billable_id": "<string>",
          "percent": 1,
          "product_id": "<string>",
          "product_pricing_id": "<string>",
          "proposal_id": "<string>",
          "state": "ACTIVE",
          "subscription_id": "<string>",
          "type": "DISCOUNT_AMOUNT"
        }
      ],
      "metadata": {},
      "minimum_spend": {
        "currency": "<string>",
        "value_in_cents": 123
      },
      "onetime_items": [
        {
          "aggregate": 2,
          "custom_price": {
            "amount": {
              "currency": "<string>",
              "value_in_cents": 123
            },
            "description": "<string>",
            "product_id": "<string>"
          },
          "product_pricing_id": "<string>",
          "quantity_config": {
            "allow_custom_quantity": true,
            "max_quantity": 123,
            "min_quantity": 123
          }
        }
      ],
      "payment_method_id": "<string>",
      "product_pricing_ids": [
        "<string>"
      ],
      "proration_type": "NEXT",
      "relative_term": {
        "count": 2,
        "frequency": "HOUR"
      },
      "reset_billing_anchor": true,
      "term": {
        "count": 2,
        "frequency": "HOUR"
      },
      "timing": "IMMEDIATE",
      "trial": true,
      "trial_term": {
        "count": 2,
        "frequency": "HOUR"
      }
    }
  ],
  "signatories": [
    {
      "declined": true,
      "email": "<string>",
      "name": "<string>",
      "position": 123,
      "signature_id": "<string>",
      "signature_link": "<string>",
      "signed": true,
      "signed_date": "2023-11-07T05:31:56Z",
      "title": "<string>",
      "view_timestamps": [
        "2023-11-07T05:31:56Z"
      ]
    }
  ],
  "signed_date": "2023-11-07T05:31:56Z",
  "signed_file_id": "<string>",
  "signed_offline": true,
  "start_date": "2023-11-07T05:31:56Z",
  "start_type": "<string>",
  "status": "<string>",
  "subscription": {
    "id": "<string>"
  },
  "subscription_id": "<string>",
  "tcv": {
    "currency": "<string>",
    "value_in_cents": 123
  },
  "template_id": "<string>",
  "template_variables": [
    "<string>"
  ],
  "term": {
    "count": 2,
    "frequency": "HOUR"
  },
  "title": "<string>",
  "trial": true,
  "trial_term": {
    "count": 2,
    "frequency": "HOUR"
  },
  "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

Company ID. It should have a prefix 'cmp_'.

id
string
required

resource id

Response

200 - application/json

OK

The response is of type object.