Skip to main content
POST
/
companies
/
{company_id}
/
contracts
Create Contract
curl --request POST \
  --url https://api.maplebilling.com/api/v1/companies/{company_id}/contracts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "auto_charges": null,
  "auto_renews": null,
  "bundle_pricing_id": null,
  "config_items": [
    {
      "hide_at_checkout": null,
      "minimum_units": 1,
      "num_licenses": 1,
      "product_metric_pricing_id": null,
      "product_pricing_id": null,
      "quantity_config": {
        "allow_custom_quantity": true,
        "max_quantity": 123,
        "min_quantity": 123
      },
      "sort_order": null,
      "upsell_product_metric_pricing_id": null
    }
  ],
  "custom_variables": {},
  "customer_id": "<string>",
  "discounts": [
    {
      "amount": {
        "currency": "<string>",
        "value_in_cents": 123
      },
      "cap": {
        "currency": "<string>",
        "value_in_cents": 123
      },
      "coupon_id": null,
      "customer_id": null,
      "expiration_date": null,
      "import_created_at_ref": null,
      "import_ref": null,
      "imported_from": null,
      "item_pricing_id": null,
      "name": "<string>",
      "onetime_billable_id": null,
      "percent": 0.5,
      "product_id": null,
      "product_pricing_id": null,
      "proposal_id": null,
      "state": null,
      "subscription_id": null,
      "type": "DISCOUNT_AMOUNT"
    }
  ],
  "expiration_date": null,
  "metadata": {},
  "onetime_items": [
    {
      "aggregate": 123,
      "custom_price": {
        "amount": {
          "currency": "<string>",
          "value_in_cents": 123
        },
        "description": "<string>",
        "product_id": "<string>"
      },
      "product_pricing_id": null,
      "quantity_config": {
        "allow_custom_quantity": true,
        "max_quantity": 123,
        "min_quantity": 123
      },
      "sort_order": null
    }
  ],
  "options": {
    "allow_promo_code": null,
    "completion_action": null,
    "confirmation_message": null,
    "redirect_url": null,
    "requires_customer_address": null
  },
  "owner_id": "<string>",
  "product_pricing_ids": [
    "<string>"
  ],
  "require_payment_method": null,
  "signatories": [
    {
      "declined": true,
      "email": "<string>",
      "name": "<string>",
      "position": null,
      "signature_id": "<string>",
      "signature_link": "<string>",
      "signed": true,
      "signed_date": null,
      "title": "<string>",
      "view_timestamps": [
        "2023-11-07T05:31:56Z"
      ]
    }
  ],
  "start_date": null,
  "status": null,
  "template_id": "<string>",
  "term": {
    "count": 1,
    "frequency": "HOUR"
  },
  "title": "<string>",
  "trial": null,
  "trial_term": {
    "count": 1,
    "frequency": "HOUR"
  },
  "type": "CONTRACT"
}'
{
  "acv": {
    "currency": "<any>",
    "value_in_cents": "<any>"
  },
  "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>",
              "id": "<string>",
              "inherited_from_id": null,
              "inherited_from_type": null,
              "key": "<string>",
              "name": "<string>",
              "original_value": "<any>",
              "overridden": null,
              "type": "<string>",
              "value": "<any>"
            }
          ],
          "external_name": "<string>",
          "id": "<string>",
          "image_url": null,
          "import_created_at_ref": null,
          "import_ref": null,
          "imported_from": null,
          "metadata": {},
          "name": "<string>",
          "product_pricings": [
            {
              "company_id": "<string>",
              "computed_entitlements": [
                {
                  "entitlement_id": "<string>",
                  "id": "<string>",
                  "inherited_from_id": null,
                  "inherited_from_type": null,
                  "key": "<string>",
                  "name": "<string>",
                  "original_value": "<any>",
                  "overridden": null,
                  "type": "<string>",
                  "value": "<any>"
                }
              ],
              "created_at": "2023-11-07T05:31:56Z",
              "currency": "<string>",
              "description": "<string>",
              "external_name": "<string>",
              "id": "<string>",
              "import_created_at_ref": null,
              "import_ref": null,
              "imported_from": null,
              "metadata": {},
              "name": "<string>",
              "num_subs": 1,
              "override_entitlements": [
                {
                  "entitlement_id": "<string>",
                  "id": "<string>",
                  "inherited_from_id": null,
                  "inherited_from_type": null,
                  "key": "<string>",
                  "name": "<string>",
                  "original_value": "<any>",
                  "overridden": null,
                  "type": "<string>",
                  "value": "<any>"
                }
              ],
              "product": {},
              "product_id": "<string>",
              "product_metric_pricings": [
                {
                  "company_id": "<string>",
                  "created_at": "2023-11-07T05:31:56Z",
                  "id": "<string>",
                  "item": {
                    "company_id": "<any>",
                    "created_at": "<any>",
                    "description": "<any>",
                    "display_type": "<any>",
                    "editable": "<any>",
                    "external_name": "<any>",
                    "id": "<any>",
                    "name": "<any>",
                    "standard": "<any>",
                    "type": "<any>",
                    "updated_at": "<any>"
                  },
                  "item_id": "<string>",
                  "item_pricing": {
                    "base_price": "<any>",
                    "base_units": "<any>",
                    "carry_over": "<any>",
                    "charge_type": "<any>",
                    "company": "<any>",
                    "company_id": "<any>",
                    "created_at": "<any>",
                    "credit_price": "<any>",
                    "custom_price": "<any>",
                    "description": "<any>",
                    "display_type": "<any>",
                    "editable": "<any>",
                    "external_name": "<any>",
                    "fixed_price": "<any>",
                    "frequency": "<any>",
                    "gradient_price": "<any>",
                    "id": "<any>",
                    "item": "<any>",
                    "item_id": "<any>",
                    "metadata": "<any>",
                    "minimum_spend": "<any>",
                    "minimum_spend_schedule": "<any>",
                    "name": "<any>",
                    "num_subs": "<any>",
                    "proration_type": "<any>",
                    "recognition_schedule": "<any>",
                    "scheduled_price": "<any>",
                    "state": "<any>",
                    "step_price": "<any>",
                    "term_count": "<any>",
                    "true_up_frequency": "<any>",
                    "type": "<any>",
                    "updated_at": "<any>",
                    "volume_price": "<any>"
                  },
                  "item_pricing_id": "<string>",
                  "metric": {
                    "company_id": "<any>",
                    "created_at": "<any>",
                    "description": "<any>",
                    "external_name": "<any>",
                    "id": "<any>",
                    "item_id": "<any>",
                    "metering_rule": "<any>",
                    "name": "<any>",
                    "standard": "<any>",
                    "type": "<any>",
                    "updated_at": "<any>"
                  },
                  "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": null
            }
          ],
          "state": "<string>",
          "tags": [
            "<string>"
          ],
          "updated_at": "2023-11-07T05:31:56Z"
        },
        "product_id": "<string>",
        "product_pricing": {
          "company_id": "<string>",
          "computed_entitlements": [
            {
              "entitlement_id": "<string>",
              "id": "<string>",
              "inherited_from_id": null,
              "inherited_from_type": null,
              "key": "<string>",
              "name": "<string>",
              "original_value": "<any>",
              "overridden": null,
              "type": "<string>",
              "value": "<any>"
            }
          ],
          "created_at": "2023-11-07T05:31:56Z",
          "currency": "<string>",
          "description": "<string>",
          "external_name": "<string>",
          "id": "<string>",
          "import_created_at_ref": null,
          "import_ref": null,
          "imported_from": null,
          "metadata": {},
          "name": "<string>",
          "num_subs": 1,
          "override_entitlements": [
            {
              "entitlement_id": "<string>",
              "id": "<string>",
              "inherited_from_id": null,
              "inherited_from_type": null,
              "key": "<string>",
              "name": "<string>",
              "original_value": "<any>",
              "overridden": null,
              "type": "<string>",
              "value": "<any>"
            }
          ],
          "product": {},
          "product_id": "<string>",
          "product_metric_pricings": [
            {
              "company_id": "<string>",
              "created_at": "2023-11-07T05:31:56Z",
              "id": "<string>",
              "item": {
                "company_id": "<any>",
                "created_at": "<any>",
                "description": "<any>",
                "display_type": "<any>",
                "editable": "<any>",
                "external_name": "<any>",
                "id": "<any>",
                "name": "<any>",
                "standard": "<any>",
                "type": "<any>",
                "updated_at": "<any>"
              },
              "item_id": "<string>",
              "item_pricing": {
                "base_price": "<any>",
                "base_units": "<any>",
                "carry_over": "<any>",
                "charge_type": "<any>",
                "company": "<any>",
                "company_id": "<any>",
                "created_at": "<any>",
                "credit_price": "<any>",
                "custom_price": "<any>",
                "description": "<any>",
                "display_type": "<any>",
                "editable": "<any>",
                "external_name": "<any>",
                "fixed_price": "<any>",
                "frequency": "<any>",
                "gradient_price": "<any>",
                "id": "<any>",
                "item": "<any>",
                "item_id": "<any>",
                "metadata": "<any>",
                "minimum_spend": "<any>",
                "minimum_spend_schedule": "<any>",
                "name": "<any>",
                "num_subs": "<any>",
                "proration_type": "<any>",
                "recognition_schedule": "<any>",
                "scheduled_price": "<any>",
                "state": "<any>",
                "step_price": "<any>",
                "term_count": "<any>",
                "true_up_frequency": "<any>",
                "type": "<any>",
                "updated_at": "<any>",
                "volume_price": "<any>"
              },
              "item_pricing_id": "<string>",
              "metric": {
                "company_id": "<any>",
                "created_at": "<any>",
                "description": "<any>",
                "external_name": "<any>",
                "id": "<any>",
                "item_id": "<any>",
                "metering_rule": "<any>",
                "name": "<any>",
                "standard": "<any>",
                "type": "<any>",
                "updated_at": "<any>"
              },
              "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": null
        },
        "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": 1,
      "frequency": "HOUR"
    },
    "updated_at": "2023-11-07T05:31:56Z"
  },
  "bundle_pricing_id": "<string>",
  "campaigns": [
    {
      "amount": {
        "currency": "<any>",
        "value_in_cents": "<any>"
      },
      "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": "<any>",
          "value_in_cents": "<any>"
        },
        "due_date": "2023-11-07T05:31:56Z",
        "hosted_link": null,
        "invoice_date": "2023-11-07T05:31:56Z",
        "name": "<string>",
        "number": "<string>",
        "paid": {
          "currency": "<any>",
          "value_in_cents": "<any>"
        },
        "paid_date": null,
        "pdf_link": null,
        "prorated_amount": {
          "currency": "<any>",
          "value_in_cents": "<any>"
        },
        "status": "<string>",
        "sub_total": {
          "currency": "<any>",
          "value_in_cents": "<any>"
        },
        "subscription_id": null,
        "total": {
          "currency": "<any>",
          "value_in_cents": "<any>"
        },
        "updated_at": "2023-11-07T05:31:56Z",
        "uuid": "<string>"
      },
      "next_action_in": null,
      "next_action_type": null,
      "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": "<any>",
              "value_in_cents": "<any>"
            },
            "total_amount_default_currency": {
              "currency": "<any>",
              "value_in_cents": "<any>"
            },
            "transaction_type": "<string>",
            "updated_at": "2023-11-07T05:31:56Z"
          },
          "status": "<string>",
          "step_number": 1
        }
      ],
      "time_from_reference_data": null,
      "total_steps": 1,
      "type": "<string>",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "change_custom_date": null,
  "change_proration_type": "<string>",
  "change_reset_billing_anchor": null,
  "change_timing": "<string>",
  "company": {
    "address": {},
    "computed_entitlements": {},
    "created_at": "2023-11-07T05:31:56Z",
    "customer_id": null,
    "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": null,
  "config_items": [
    {
      "hide_at_checkout": null,
      "minimum_units": 1,
      "num_licenses": 1,
      "product_metric_pricing_id": null,
      "product_pricing_id": null,
      "quantity_config": {
        "allow_custom_quantity": true,
        "max_quantity": 123,
        "min_quantity": 123
      },
      "sort_order": null,
      "upsell_product_metric_pricing_id": null
    }
  ],
  "content": null,
  "content_template": null,
  "contract_attachments": [
    {
      "attachment_type": null,
      "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": null,
      "signature_id": null,
      "signed": true,
      "signed_date": null
    }
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "currency": "<string>",
  "custom_variables": {},
  "customer": {
    "address": {
      "address_line_1": "<string>",
      "address_line_2": "<string>",
      "city": "<string>",
      "country": "US",
      "place_id": null,
      "state": "<string>",
      "zip": "<string>"
    },
    "billing_emails": [
      "<string>"
    ],
    "email": "<string>",
    "id": "<string>",
    "identifier": "<string>",
    "name": "<string>",
    "org_name": "<string>",
    "parent_customer": {},
    "parent_customer_id": null,
    "phone": "<string>"
  },
  "customer_id": null,
  "discounts": [
    {
      "amount": {
        "currency": "<any>",
        "value_in_cents": "<any>"
      },
      "cap": {
        "currency": "<any>",
        "value_in_cents": "<any>"
      },
      "company_id": "<string>",
      "coupon_id": null,
      "created_at": "2023-11-07T05:31:56Z",
      "customer_id": null,
      "deleted_at": {},
      "expiration_date": null,
      "id": "<string>",
      "import_created_at_ref": null,
      "import_ref": null,
      "imported_from": null,
      "item_pricing_id": null,
      "name": "<string>",
      "onetime_billable": {
        "aggregate": 123,
        "company_id": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "custom_price": {
          "amount": {
            "currency": "<any>",
            "value_in_cents": "<any>"
          },
          "description": "<string>",
          "product_id": "<string>"
        },
        "customer_id": null,
        "deleted_at": {},
        "id": "<string>",
        "import_ref": null,
        "imported_from": null,
        "name": "<string>",
        "product_pricing_id": null,
        "proposal_id": null,
        "quantity_config": {
          "allow_custom_quantity": true,
          "max_quantity": 123,
          "min_quantity": 123
        },
        "sort_order": null,
        "state": "<string>",
        "type": "<string>",
        "updated_at": "2023-11-07T05:31:56Z"
      },
      "onetime_billable_id": null,
      "percent": 123,
      "product_id": null,
      "product_pricing_id": null,
      "proposal_id": null,
      "state": "<string>",
      "subscription_id": null,
      "type": "<string>",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "expiration_date": null,
  "finalized_date": null,
  "id": "<string>",
  "invoice_due_date_from_creation": null,
  "invoice_event_grace_period": null,
  "invoice_payment_instructions": null,
  "metadata": {},
  "minimum_spend": {
    "currency": "<any>",
    "value_in_cents": "<any>"
  },
  "one_time_billables": [
    {
      "aggregate": 123,
      "company_id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "custom_price": {
        "amount": {
          "currency": "<any>",
          "value_in_cents": "<any>"
        },
        "description": "<string>",
        "product_id": "<string>"
      },
      "customer_id": null,
      "id": "<string>",
      "name": "<string>",
      "product_pricing": {
        "company_id": "<string>",
        "computed_entitlements": [
          {
            "entitlement_id": "<string>",
            "id": "<string>",
            "inherited_from_id": null,
            "inherited_from_type": null,
            "key": "<string>",
            "name": "<string>",
            "original_value": "<any>",
            "overridden": null,
            "type": "<string>",
            "value": "<any>"
          }
        ],
        "created_at": "2023-11-07T05:31:56Z",
        "currency": "<string>",
        "description": "<string>",
        "external_name": "<string>",
        "id": "<string>",
        "import_created_at_ref": null,
        "import_ref": null,
        "imported_from": null,
        "metadata": {},
        "name": "<string>",
        "num_subs": 1,
        "override_entitlements": [
          {
            "entitlement_id": "<string>",
            "id": "<string>",
            "inherited_from_id": null,
            "inherited_from_type": null,
            "key": "<string>",
            "name": "<string>",
            "original_value": "<any>",
            "overridden": null,
            "type": "<string>",
            "value": "<any>"
          }
        ],
        "product": {},
        "product_id": "<string>",
        "product_metric_pricings": [
          {
            "company_id": "<string>",
            "created_at": "2023-11-07T05:31:56Z",
            "id": "<string>",
            "item": {
              "company_id": "<any>",
              "created_at": "<any>",
              "description": "<any>",
              "display_type": "<any>",
              "editable": "<any>",
              "external_name": "<any>",
              "id": "<any>",
              "name": "<any>",
              "standard": "<any>",
              "type": "<any>",
              "updated_at": "<any>"
            },
            "item_id": "<string>",
            "item_pricing": {
              "base_price": "<any>",
              "base_units": "<any>",
              "carry_over": "<any>",
              "charge_type": "<any>",
              "company": "<any>",
              "company_id": "<any>",
              "created_at": "<any>",
              "credit_price": "<any>",
              "custom_price": "<any>",
              "description": "<any>",
              "display_type": "<any>",
              "editable": "<any>",
              "external_name": "<any>",
              "fixed_price": "<any>",
              "frequency": "<any>",
              "gradient_price": "<any>",
              "id": "<any>",
              "item": "<any>",
              "item_id": "<any>",
              "metadata": "<any>",
              "minimum_spend": "<any>",
              "minimum_spend_schedule": "<any>",
              "name": "<any>",
              "num_subs": "<any>",
              "proration_type": "<any>",
              "recognition_schedule": "<any>",
              "scheduled_price": "<any>",
              "state": "<any>",
              "step_price": "<any>",
              "term_count": "<any>",
              "true_up_frequency": "<any>",
              "type": "<any>",
              "updated_at": "<any>",
              "volume_price": "<any>"
            },
            "item_pricing_id": "<string>",
            "metric": {
              "company_id": "<any>",
              "created_at": "<any>",
              "description": "<any>",
              "external_name": "<any>",
              "id": "<any>",
              "item_id": "<any>",
              "metering_rule": "<any>",
              "name": "<any>",
              "standard": "<any>",
              "type": "<any>",
              "updated_at": "<any>"
            },
            "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": null
      },
      "product_pricing_id": null,
      "quantity_config": {
        "allow_custom_quantity": true,
        "max_quantity": 123,
        "min_quantity": 123
      },
      "sort_order": null,
      "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": null,
  "parent_billed": true,
  "payment_config": {
    "account_id": "<string>",
    "client_secret": "<string>",
    "integration_id": null,
    "live_mode": true,
    "provider": "<string>",
    "razorpay": {
      "account_id": "<string>"
    },
    "stripe": {
      "account_id": "<string>"
    }
  },
  "payment_data": {
    "authorize_net": {
      "payment_method_id": "<string>"
    },
    "helcim": {
      "payment_method_id": null
    },
    "payment_provider_key": "stripe",
    "razor_pay": {
      "token_id": "<string>"
    },
    "stripe": {
      "payment_method_id": "<string>"
    }
  },
  "payment_provided_date": null,
  "po_number": null,
  "previous_arr": {
    "currency": "<any>",
    "value_in_cents": "<any>"
  },
  "previous_subscription": {
    "id": "<string>"
  },
  "previous_subscription_id": null,
  "processing_date": null,
  "require_payment_method": true,
  "requires_customer_confirmation": true,
  "scheduled_changes": [
    {
      "actual_change_time": null,
      "auto_charges": null,
      "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": 1,
          "frequency": "HOUR"
        },
        "deleted_at": {},
        "description": "<string>",
        "id": "<string>",
        "image_url": "<string>",
        "import_created_at_ref": null,
        "import_ref": null,
        "imported_from": null,
        "is_auto_generated": true,
        "key": "<string>",
        "metadata": {},
        "name": "<string>",
        "num_subs": 1,
        "state": "<string>",
        "updated_at": "2023-11-07T05:31:56Z"
      },
      "bundle_pricing_id": null,
      "config_items": [
        {
          "hide_at_checkout": null,
          "minimum_units": 1,
          "num_licenses": 1,
          "product_metric_pricing_id": null,
          "product_pricing_id": null,
          "quantity_config": {
            "allow_custom_quantity": true,
            "max_quantity": 123,
            "min_quantity": 123
          },
          "sort_order": null,
          "upsell_product_metric_pricing_id": null
        }
      ],
      "custom_change_date": null,
      "discounts": null,
      "metadata": {},
      "minimum_spend": {
        "currency": "<any>",
        "value_in_cents": "<any>"
      },
      "onetime_items": [
        {
          "aggregate": 123,
          "custom_price": {
            "amount": {
              "currency": "<any>",
              "value_in_cents": "<any>"
            },
            "description": "<string>",
            "product_id": "<string>"
          },
          "product_pricing_id": null,
          "quantity_config": {
            "allow_custom_quantity": true,
            "max_quantity": 123,
            "min_quantity": 123
          },
          "sort_order": null
        }
      ],
      "payment_method_id": null,
      "product_pricing_ids": [
        "<string>"
      ],
      "proration_type": "NEXT",
      "relative_term": {
        "count": 1,
        "frequency": "HOUR"
      },
      "reset_billing_anchor": null,
      "term": {
        "count": 1,
        "frequency": "HOUR"
      },
      "timing": "IMMEDIATE",
      "trial": null,
      "trial_term": {
        "count": 1,
        "frequency": "HOUR"
      }
    }
  ],
  "signatories": [
    {
      "declined": true,
      "email": "<string>",
      "name": "<string>",
      "position": null,
      "signature_id": "<string>",
      "signature_link": "<string>",
      "signed": true,
      "signed_date": null,
      "title": "<string>",
      "view_timestamps": [
        "2023-11-07T05:31:56Z"
      ]
    }
  ],
  "signed_date": null,
  "signed_file_id": null,
  "signed_offline": true,
  "start_date": null,
  "start_type": "<string>",
  "status": "<string>",
  "subscription": {
    "id": "<string>"
  },
  "subscription_id": null,
  "tcv": {
    "currency": "<any>",
    "value_in_cents": "<any>"
  },
  "template_id": null,
  "template_variables": [
    "<string>"
  ],
  "term": {
    "count": 1,
    "frequency": "HOUR"
  },
  "title": "<string>",
  "trial": true,
  "trial_term": {
    "count": 1,
    "frequency": "HOUR"
  },
  "type": "<string>",
  "updated_at": "2023-11-07T05:31:56Z",
  "variable_configs": [
    {
      "default": "<string>",
      "is_custom": true,
      "is_editable": true,
      "key": "<string>",
      "name": "<string>",
      "tag": "<string>",
      "type": "<string>",
      "validation": "<string>",
      "value": "<string>"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
Idempotency-Key
string

The idempotency key that will be used to ensure the request is only performed once

Path Parameters

​
company_id
string
required

The company ID with the prefix 'cmp_'.

Body

application/json
​
config_items
object[]
required
​
customer_id
string
required

The customer attached to the contract

​
signatories
object[] | null
required

The signatories for the contract

​
template_id
string
required

The template to use for the contract

​
title
string
required

The title for the contract

​
type
enum<string>
required

The type of the proposal

Available options:
CONTRACT
​
auto_charges
boolean | null

Whether the subscription is automatically charged to the payment method after the contract is signed

​
auto_renews
boolean | null

Whether this subscription auto renews at the end of the term. This is to be used without end date or renewal date

​
bundle_pricing_id
string | null

The bundle that form the contract.

​
custom_variables
object | null

The custom variables for the contract as key-value pairs

​
discounts
object[] | null

The discounts attached to the contract

​
expiration_date
string<date-time> | null

The expiration date for the contract in RFC-3339 format

​
metadata
object

Any additional data as key-value pairs that needs to be attached to the subscription after the contract is signed

​
onetime_items
object[] | null

Any one time charges to be attached to the contract

​
options
object | null

The detailed options for the contract such as confirmation messages, redirect urls etc.

​
owner_id
string | null

The company user ID of the user in Maple assigned to manage this contract

​
product_pricing_ids
string[] | null

The list of product pricings that form the contract

​
require_payment_method
boolean | null

Whether the contract requires a payment method to be executed

​
start_date
string<date-time> | null

The start date for the contract in RFC-3339 format, if it does not start immediately

​
status
enum<string> | null

The status of the contract, defaults to DRAFT

Available options:
DRAFT,
PENDING_SIGNATURES
​
term
object

The term for the subscription created by the contract

​
trial
boolean | null

Whether the contract creates a subscription in a trial

​
trial_term
object

The trial term for the subscription after the contract is executed

Response

200 - application/json

OK

​
acv
object

The amount which has value in cents and a currency

​
auto_charges
boolean
​
auto_renews
boolean
​
bundle_pricing
object
​
bundle_pricing_id
string
​
campaigns
object[] | null
​
change_custom_date
string<date-time> | null
​
change_proration_type
string | null
​
change_reset_billing_anchor
boolean | null
​
change_timing
string | null
​
company
object
​
company_id
string
​
completed_date
string<date-time> | null
​
config_items
object[] | null
​
content
string | null
​
content_template
string | null
​
contract_attachments
object[] | null
​
counter_signatories
object[] | null
​
created_at
string<date-time>
​
currency
string | null
​
custom_variables
object | null
​
customer
object
​
customer_id
string | null
​
discounts
object[] | null
​
expiration_date
string<date-time> | null
​
finalized_date
string<date-time> | null
​
id
string
​
invoice_due_date_from_creation
integer | null
Required range: x >= 0
​
invoice_event_grace_period
integer | null
Required range: x >= 0
​
invoice_payment_instructions
string | null

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

​
metadata
object
​
minimum_spend
object

The amount which has value in cents and a currency

​
one_time_billables
object[] | null
​
options
object
​
owner
object
​
owner_id
string | null
​
parent_billed
boolean
​
payment_config
object
​
payment_data
object
​
payment_provided_date
string<date-time> | null
​
po_number
string | null
​
previous_arr
object

The amount which has value in cents and a currency

​
previous_subscription
object
​
previous_subscription_id
string | null
​
processing_date
string<date-time> | null
​
require_payment_method
boolean
​
requires_customer_confirmation
boolean
​
scheduled_changes
object[] | null
​
signatories
object[] | null
​
signed_date
string<date-time> | null
​
signed_file_id
string | null
​
signed_offline
boolean
​
start_date
string<date-time> | null
​
start_type
string
​
status
string
​
subscription
object
​
subscription_id
string | null
​
tcv
object

The amount which has value in cents and a currency

​
template_id
string | null
​
template_variables
string[] | null
​
term
object

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

​
title
string
​
trial
boolean
​
trial_term
object

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

​
type
string
​
updated_at
string<date-time>
​
variable_configs
object[] | null
⌘I