POST
/
subscriptions
/
{subscription_id}
/
cancel
curl --request POST \
  --url https://api.withorb.com/v1/subscriptions/{subscription_id}/cancel \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "cancel_option": "end_of_subscription_term",
  "cancellation_date": "2023-11-07T05:31:56Z",
  "allow_invoice_credit_or_void": true
}'
{
  "metadata": {},
  "id": "<string>",
  "customer": {
    "metadata": {},
    "id": "<string>",
    "external_customer_id": "<string>",
    "name": "<string>",
    "email": "<string>",
    "timezone": "<string>",
    "payment_provider_id": "<string>",
    "payment_provider": "quickbooks",
    "created_at": "2023-11-07T05:31:56Z",
    "shipping_address": {
      "line1": "<string>",
      "line2": "<string>",
      "city": "<string>",
      "state": "<string>",
      "postal_code": "<string>",
      "country": "<string>"
    },
    "billing_address": {
      "line1": "<string>",
      "line2": "<string>",
      "city": "<string>",
      "state": "<string>",
      "postal_code": "<string>",
      "country": "<string>"
    },
    "balance": "<string>",
    "currency": "<string>",
    "tax_id": {
      "country": "AD",
      "type": "ad_nrt",
      "value": "<string>"
    },
    "auto_collection": true,
    "exempt_from_automated_tax": true,
    "email_delivery": true,
    "additional_emails": [
      "<string>"
    ],
    "portal_url": "<string>",
    "accounting_sync_configuration": {
      "excluded": true,
      "accounting_providers": [
        {
          "provider_type": "quickbooks",
          "external_provider_id": "<string>"
        }
      ]
    },
    "reporting_configuration": {
      "exempt": true
    },
    "hierarchy": {
      "parent": {
        "id": "<string>",
        "external_customer_id": "<string>"
      },
      "children": [
        {
          "id": "<string>",
          "external_customer_id": "<string>"
        }
      ]
    }
  },
  "plan": {
    "metadata": {},
    "id": "<string>",
    "name": "<string>",
    "description": "<string>",
    "maximum_amount": "<string>",
    "minimum_amount": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "status": "active",
    "maximum": {
      "maximum_amount": "<string>",
      "applies_to_price_ids": [
        "<string>"
      ]
    },
    "minimum": {
      "minimum_amount": "<string>",
      "applies_to_price_ids": [
        "<string>"
      ]
    },
    "discount": {
      "discount_type": "percentage",
      "applies_to_price_ids": [
        "h74gfhdjvn7ujokd",
        "7hfgtgjnbvc3ujkl"
      ],
      "reason": "<string>",
      "percentage_discount": 0.15
    },
    "product": {
      "created_at": "2023-11-07T05:31:56Z",
      "id": "<string>",
      "name": "<string>"
    },
    "version": 123,
    "trial_config": {
      "trial_period": 123,
      "trial_period_unit": "days"
    },
    "plan_phases": [
      {
        "id": "<string>",
        "description": "<string>",
        "duration": 123,
        "duration_unit": "daily",
        "name": "<string>",
        "order": 123,
        "minimum": {
          "minimum_amount": "<string>",
          "applies_to_price_ids": [
            "<string>"
          ]
        },
        "maximum": {
          "maximum_amount": "<string>",
          "applies_to_price_ids": [
            "<string>"
          ]
        },
        "maximum_amount": "<string>",
        "minimum_amount": "<string>",
        "discount": {
          "discount_type": "percentage",
          "applies_to_price_ids": [
            "h74gfhdjvn7ujokd",
            "7hfgtgjnbvc3ujkl"
          ],
          "reason": "<string>",
          "percentage_discount": 0.15
        }
      }
    ],
    "base_plan": {
      "id": "m2t5akQeh2obwxeU",
      "external_plan_id": "m2t5akQeh2obwxeU",
      "name": "Example plan"
    },
    "base_plan_id": "<string>",
    "external_plan_id": "<string>",
    "currency": "<string>",
    "invoicing_currency": "<string>",
    "net_terms": 123,
    "default_invoice_memo": "<string>",
    "prices": [
      {
        "metadata": {},
        "id": "<string>",
        "name": "<string>",
        "external_price_id": "<string>",
        "price_type": "usage_price",
        "model_type": "unit",
        "created_at": "2023-11-07T05:31:56Z",
        "cadence": "one_time",
        "billing_cycle_configuration": {
          "duration": 123,
          "duration_unit": "day"
        },
        "invoicing_cycle_configuration": {
          "duration": 123,
          "duration_unit": "day"
        },
        "billable_metric": {
          "id": "<string>"
        },
        "dimensional_price_configuration": {
          "dimensional_price_group_id": "<string>",
          "dimension_values": [
            "<string>"
          ]
        },
        "fixed_price_quantity": 123,
        "plan_phase_order": 123,
        "currency": "<string>",
        "conversion_rate": 123,
        "item": {
          "id": "<string>",
          "name": "<string>"
        },
        "credit_allocation": {
          "currency": "<string>",
          "allows_rollover": true
        },
        "discount": {
          "discount_type": "percentage",
          "applies_to_price_ids": [
            "h74gfhdjvn7ujokd",
            "7hfgtgjnbvc3ujkl"
          ],
          "reason": "<string>",
          "percentage_discount": 0.15
        },
        "minimum": {
          "minimum_amount": "<string>",
          "applies_to_price_ids": [
            "<string>"
          ]
        },
        "minimum_amount": "<string>",
        "maximum": {
          "maximum_amount": "<string>",
          "applies_to_price_ids": [
            "<string>"
          ]
        },
        "maximum_amount": "<string>",
        "unit_config": {
          "unit_amount": "<string>"
        }
      }
    ],
    "adjustments": [
      {
        "id": "<string>",
        "is_invoice_level": true,
        "applies_to_price_ids": [
          "<string>"
        ],
        "reason": "<string>",
        "adjustment_type": "usage_discount",
        "usage_discount": 123,
        "plan_phase_order": 123
      }
    ]
  },
  "start_date": "2023-11-07T05:31:56Z",
  "end_date": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "current_billing_period_start_date": "2023-11-07T05:31:56Z",
  "current_billing_period_end_date": "2023-11-07T05:31:56Z",
  "status": "active",
  "trial_info": {
    "end_date": "2023-11-07T05:31:56Z"
  },
  "active_plan_phase_order": 123,
  "fixed_fee_quantity_schedule": [
    {
      "price_id": "<string>",
      "start_date": "2023-11-07T05:31:56Z",
      "end_date": "2023-11-07T05:31:56Z",
      "quantity": 123
    }
  ],
  "default_invoice_memo": "<string>",
  "auto_collection": true,
  "net_terms": 123,
  "redeemed_coupon": {
    "coupon_id": "<string>",
    "start_date": "2023-11-07T05:31:56Z",
    "end_date": "2023-11-07T05:31:56Z"
  },
  "billing_cycle_day": 16,
  "billing_cycle_anchor_configuration": {
    "day": 16,
    "month": 6,
    "year": 123
  },
  "invoicing_threshold": "<string>",
  "price_intervals": [
    {
      "id": "<string>",
      "start_date": "2023-11-07T05:31:56Z",
      "end_date": "2023-11-07T05:31:56Z",
      "price": {
        "metadata": {},
        "id": "<string>",
        "name": "<string>",
        "external_price_id": "<string>",
        "price_type": "usage_price",
        "model_type": "unit",
        "created_at": "2023-11-07T05:31:56Z",
        "cadence": "one_time",
        "billing_cycle_configuration": {
          "duration": 123,
          "duration_unit": "day"
        },
        "invoicing_cycle_configuration": {
          "duration": 123,
          "duration_unit": "day"
        },
        "billable_metric": {
          "id": "<string>"
        },
        "dimensional_price_configuration": {
          "dimensional_price_group_id": "<string>",
          "dimension_values": [
            "<string>"
          ]
        },
        "fixed_price_quantity": 123,
        "plan_phase_order": 123,
        "currency": "<string>",
        "conversion_rate": 123,
        "item": {
          "id": "<string>",
          "name": "<string>"
        },
        "credit_allocation": {
          "currency": "<string>",
          "allows_rollover": true
        },
        "discount": {
          "discount_type": "percentage",
          "applies_to_price_ids": [
            "h74gfhdjvn7ujokd",
            "7hfgtgjnbvc3ujkl"
          ],
          "reason": "<string>",
          "percentage_discount": 0.15
        },
        "minimum": {
          "minimum_amount": "<string>",
          "applies_to_price_ids": [
            "<string>"
          ]
        },
        "minimum_amount": "<string>",
        "maximum": {
          "maximum_amount": "<string>",
          "applies_to_price_ids": [
            "<string>"
          ]
        },
        "maximum_amount": "<string>",
        "unit_config": {
          "unit_amount": "<string>"
        }
      },
      "billing_cycle_day": 123,
      "fixed_fee_quantity_transitions": [
        {
          "price_id": "<string>",
          "effective_date": "2023-11-07T05:31:56Z",
          "quantity": 123
        }
      ],
      "current_billing_period_start_date": "2023-11-07T05:31:56Z",
      "current_billing_period_end_date": "2023-11-07T05:31:56Z",
      "filter": "<string>",
      "usage_customer_ids": [
        "<string>"
      ]
    }
  ],
  "adjustment_intervals": [
    {
      "id": "<string>",
      "adjustment": {
        "id": "<string>",
        "is_invoice_level": true,
        "applies_to_price_ids": [
          "<string>"
        ],
        "reason": "<string>",
        "adjustment_type": "usage_discount",
        "usage_discount": 123,
        "plan_phase_order": 123
      },
      "start_date": "2023-11-07T05:31:56Z",
      "end_date": "2023-11-07T05:31:56Z",
      "applies_to_price_interval_ids": [
        "<string>"
      ]
    }
  ],
  "discount_intervals": [
    {
      "discount_type": "amount",
      "amount_discount": "<string>",
      "start_date": "2023-11-07T05:31:56Z",
      "end_date": "2023-11-07T05:31:56Z",
      "applies_to_price_ids": [
        "<string>"
      ],
      "applies_to_price_interval_ids": [
        "<string>"
      ]
    }
  ],
  "minimum_intervals": [
    {
      "start_date": "2023-11-07T05:31:56Z",
      "end_date": "2023-11-07T05:31:56Z",
      "applies_to_price_ids": [
        "<string>"
      ],
      "applies_to_price_interval_ids": [
        "<string>"
      ],
      "minimum_amount": "<string>"
    }
  ],
  "maximum_intervals": [
    {
      "start_date": "2023-11-07T05:31:56Z",
      "end_date": "2023-11-07T05:31:56Z",
      "applies_to_price_ids": [
        "<string>"
      ],
      "applies_to_price_interval_ids": [
        "<string>"
      ],
      "maximum_amount": "<string>"
    }
  ],
  "pending_subscription_change": {
    "id": "<string>"
  },
  "changed_resources": {
    "created_credit_notes": [
      {
        "id": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "voided_at": "2023-11-07T05:31:56Z",
        "credit_note_number": "<string>",
        "invoice_id": "<string>",
        "memo": "<string>",
        "reason": "Duplicate",
        "type": "refund",
        "subtotal": "<string>",
        "total": "<string>",
        "customer": {
          "id": "<string>",
          "external_customer_id": "<string>"
        },
        "credit_note_pdf": "<string>",
        "minimum_amount_refunded": "<string>",
        "discounts": [
          {
            "discount_type": "percentage",
            "percentage_discount": 123,
            "amount_applied": "<string>",
            "reason": "<string>",
            "applies_to_prices": [
              {
                "id": "<string>",
                "name": "<string>"
              }
            ]
          }
        ],
        "maximum_amount_adjustment": {
          "discount_type": "percentage",
          "percentage_discount": 123,
          "amount_applied": "<string>",
          "reason": "<string>",
          "applies_to_prices": [
            {
              "id": "<string>",
              "name": "<string>"
            }
          ]
        },
        "line_items": [
          {
            "id": "<string>",
            "name": "<string>",
            "subtotal": "<string>",
            "amount": "<string>",
            "quantity": 123,
            "discounts": [
              {
                "id": "<string>",
                "discount_type": "percentage",
                "percentage_discount": 123,
                "amount_discount": "<string>",
                "amount_applied": "<string>",
                "reason": "<string>",
                "applies_to_price_ids": [
                  "<string>"
                ]
              }
            ],
            "tax_amounts": [
              {
                "tax_rate_description": "<string>",
                "tax_rate_percentage": "<string>",
                "amount": "<string>"
              }
            ],
            "item_id": "<string>"
          }
        ]
      }
    ],
    "voided_credit_notes": [
      {
        "id": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "voided_at": "2023-11-07T05:31:56Z",
        "credit_note_number": "<string>",
        "invoice_id": "<string>",
        "memo": "<string>",
        "reason": "Duplicate",
        "type": "refund",
        "subtotal": "<string>",
        "total": "<string>",
        "customer": {
          "id": "<string>",
          "external_customer_id": "<string>"
        },
        "credit_note_pdf": "<string>",
        "minimum_amount_refunded": "<string>",
        "discounts": [
          {
            "discount_type": "percentage",
            "percentage_discount": 123,
            "amount_applied": "<string>",
            "reason": "<string>",
            "applies_to_prices": [
              {
                "id": "<string>",
                "name": "<string>"
              }
            ]
          }
        ],
        "maximum_amount_adjustment": {
          "discount_type": "percentage",
          "percentage_discount": 123,
          "amount_applied": "<string>",
          "reason": "<string>",
          "applies_to_prices": [
            {
              "id": "<string>",
              "name": "<string>"
            }
          ]
        },
        "line_items": [
          {
            "id": "<string>",
            "name": "<string>",
            "subtotal": "<string>",
            "amount": "<string>",
            "quantity": 123,
            "discounts": [
              {
                "id": "<string>",
                "discount_type": "percentage",
                "percentage_discount": 123,
                "amount_discount": "<string>",
                "amount_applied": "<string>",
                "reason": "<string>",
                "applies_to_price_ids": [
                  "<string>"
                ]
              }
            ],
            "tax_amounts": [
              {
                "tax_rate_description": "<string>",
                "tax_rate_percentage": "<string>",
                "amount": "<string>"
              }
            ],
            "item_id": "<string>"
          }
        ]
      }
    ],
    "created_invoices": [
      {
        "metadata": {},
        "voided_at": "2023-11-07T05:31:56Z",
        "paid_at": "2023-11-07T05:31:56Z",
        "issued_at": "2023-11-07T05:31:56Z",
        "scheduled_issue_at": "2023-11-07T05:31:56Z",
        "auto_collection": {
          "next_attempt_at": "2023-11-07T05:31:56Z",
          "previously_attempted_at": "2023-11-07T05:31:56Z",
          "enabled": true,
          "num_attempts": 123
        },
        "issue_failed_at": "2023-11-07T05:31:56Z",
        "sync_failed_at": "2023-11-07T05:31:56Z",
        "payment_failed_at": "2023-11-07T05:31:56Z",
        "payment_started_at": "2023-11-07T05:31:56Z",
        "amount_due": "8.00",
        "created_at": "2022-05-01T07:01:31+00:00",
        "currency": "USD",
        "customer": {
          "id": "<string>",
          "external_customer_id": "<string>"
        },
        "discount": "<any>",
        "discounts": [
          {
            "discount_type": "percentage",
            "applies_to_price_ids": [
              "h74gfhdjvn7ujokd",
              "7hfgtgjnbvc3ujkl"
            ],
            "reason": "<string>",
            "percentage_discount": 0.15
          }
        ],
        "due_date": "2022-05-30T07:00:00+00:00",
        "id": "<string>",
        "invoice_pdf": "https://assets.withorb.com/invoice/rUHdhmg45vY45DX/qEAeuYePaphGMdFb",
        "invoice_number": "JYEFHK-00001",
        "minimum": {
          "minimum_amount": "<string>",
          "applies_to_price_ids": [
            "<string>"
          ]
        },
        "minimum_amount": "<string>",
        "maximum": {
          "maximum_amount": "<string>",
          "applies_to_price_ids": [
            "<string>"
          ]
        },
        "maximum_amount": "<string>",
        "line_items": [
          {
            "amount": "7.00",
            "discount": {
              "discount_type": "percentage",
              "applies_to_price_ids": [
                "h74gfhdjvn7ujokd",
                "7hfgtgjnbvc3ujkl"
              ],
              "reason": "<string>",
              "percentage_discount": 0.15
            },
            "end_date": "2022-02-01T08:00:00+00:00",
            "grouping": "<string>",
            "minimum": {
              "minimum_amount": "<string>",
              "applies_to_price_ids": [
                "<string>"
              ]
            },
            "minimum_amount": "<string>",
            "maximum": {
              "maximum_amount": "<string>",
              "applies_to_price_ids": [
                "<string>"
              ]
            },
            "maximum_amount": "<string>",
            "adjustments": [
              {
                "id": "<string>",
                "is_invoice_level": true,
                "applies_to_price_ids": [
                  "<string>"
                ],
                "reason": "<string>",
                "adjustment_type": "usage_discount",
                "usage_discount": 123,
                "amount": "<string>"
              }
            ],
            "name": "Fixed Fee",
            "quantity": 1,
            "start_date": "2022-02-01T08:00:00+00:00",
            "subtotal": "9.00",
            "adjusted_subtotal": "5.00",
            "credits_applied": "6.00",
            "partially_invoiced_amount": "4.00",
            "sub_line_items": [
              {
                "amount": "9.00",
                "name": "Tier One",
                "quantity": 5,
                "grouping": {
                  "key": "region",
                  "value": "west"
                },
                "type": "matrix",
                "matrix_config": {
                  "dimension_values": [
                    "<string>"
                  ]
                }
              }
            ],
            "tax_amounts": [
              {
                "tax_rate_description": "<string>",
                "tax_rate_percentage": "<string>",
                "amount": "<string>"
              }
            ],
            "id": "<string>",
            "price": {
              "metadata": {},
              "id": "<string>",
              "name": "<string>",
              "external_price_id": "<string>",
              "price_type": "usage_price",
              "model_type": "unit",
              "created_at": "2023-11-07T05:31:56Z",
              "cadence": "one_time",
              "billing_cycle_configuration": {
                "duration": 123,
                "duration_unit": "day"
              },
              "invoicing_cycle_configuration": {
                "duration": 123,
                "duration_unit": "day"
              },
              "billable_metric": {
                "id": "<string>"
              },
              "dimensional_price_configuration": {
                "dimensional_price_group_id": "<string>",
                "dimension_values": [
                  "<string>"
                ]
              },
              "fixed_price_quantity": 123,
              "plan_phase_order": 123,
              "currency": "<string>",
              "conversion_rate": 123,
              "item": {
                "id": "<string>",
                "name": "<string>"
              },
              "credit_allocation": {
                "currency": "<string>",
                "allows_rollover": true
              },
              "discount": {
                "discount_type": "percentage",
                "applies_to_price_ids": [
                  "h74gfhdjvn7ujokd",
                  "7hfgtgjnbvc3ujkl"
                ],
                "reason": "<string>",
                "percentage_discount": 0.15
              },
              "minimum": {
                "minimum_amount": "<string>",
                "applies_to_price_ids": [
                  "<string>"
                ]
              },
              "minimum_amount": "<string>",
              "maximum": {
                "maximum_amount": "<string>",
                "applies_to_price_ids": [
                  "<string>"
                ]
              },
              "maximum_amount": "<string>",
              "unit_config": {
                "unit_amount": "<string>"
              }
            },
            "usage_customer_ids": [
              "<string>"
            ],
            "filter": "<string>"
          }
        ],
        "subscription": {
          "id": "VDGsT23osdLb84KD"
        },
        "subtotal": "8.00",
        "total": "8.00",
        "customer_balance_transactions": [
          {
            "id": "cgZa3SXcsPTVyC4Y",
            "created_at": "2022-05-01T07:01:31+00:00",
            "starting_balance": "33.00",
            "ending_balance": "22.00",
            "amount": "11.00",
            "action": "applied_to_invoice",
            "description": "An optional description",
            "invoice": {
              "id": "gXcsPTVyC4YZa3Sc"
            },
            "type": "increment",
            "credit_note": {
              "id": "<string>"
            }
          }
        ],
        "status": "issued",
        "invoice_source": "subscription",
        "shipping_address": {
          "line1": "<string>",
          "line2": "<string>",
          "city": "<string>",
          "state": "<string>",
          "postal_code": "<string>",
          "country": "<string>"
        },
        "billing_address": {
          "line1": "<string>",
          "line2": "<string>",
          "city": "<string>",
          "state": "<string>",
          "postal_code": "<string>",
          "country": "<string>"
        },
        "hosted_invoice_url": "<string>",
        "will_auto_issue": true,
        "eligible_to_issue_at": "2023-11-07T05:31:56Z",
        "customer_tax_id": {
          "country": "AD",
          "type": "ad_nrt",
          "value": "<string>"
        },
        "memo": "<string>",
        "credit_notes": [
          {
            "id": "<string>",
            "credit_note_number": "<string>",
            "reason": "<string>",
            "total": "<string>",
            "voided_at": "2022-05-01T07:01:31+00:00",
            "type": "<string>",
            "memo": "<string>"
          }
        ],
        "payment_attempts": [
          {
            "id": "<string>",
            "payment_provider": "stripe",
            "payment_provider_id": "<string>",
            "amount": "<string>",
            "succeeded": true,
            "created_at": "2023-11-07T05:31:56Z"
          }
        ],
        "invoice_date": "2022-05-01T07:00:00+00:00"
      }
    ],
    "voided_invoices": [
      {
        "metadata": {},
        "voided_at": "2023-11-07T05:31:56Z",
        "paid_at": "2023-11-07T05:31:56Z",
        "issued_at": "2023-11-07T05:31:56Z",
        "scheduled_issue_at": "2023-11-07T05:31:56Z",
        "auto_collection": {
          "next_attempt_at": "2023-11-07T05:31:56Z",
          "previously_attempted_at": "2023-11-07T05:31:56Z",
          "enabled": true,
          "num_attempts": 123
        },
        "issue_failed_at": "2023-11-07T05:31:56Z",
        "sync_failed_at": "2023-11-07T05:31:56Z",
        "payment_failed_at": "2023-11-07T05:31:56Z",
        "payment_started_at": "2023-11-07T05:31:56Z",
        "amount_due": "8.00",
        "created_at": "2022-05-01T07:01:31+00:00",
        "currency": "USD",
        "customer": {
          "id": "<string>",
          "external_customer_id": "<string>"
        },
        "discount": "<any>",
        "discounts": [
          {
            "discount_type": "percentage",
            "applies_to_price_ids": [
              "h74gfhdjvn7ujokd",
              "7hfgtgjnbvc3ujkl"
            ],
            "reason": "<string>",
            "percentage_discount": 0.15
          }
        ],
        "due_date": "2022-05-30T07:00:00+00:00",
        "id": "<string>",
        "invoice_pdf": "https://assets.withorb.com/invoice/rUHdhmg45vY45DX/qEAeuYePaphGMdFb",
        "invoice_number": "JYEFHK-00001",
        "minimum": {
          "minimum_amount": "<string>",
          "applies_to_price_ids": [
            "<string>"
          ]
        },
        "minimum_amount": "<string>",
        "maximum": {
          "maximum_amount": "<string>",
          "applies_to_price_ids": [
            "<string>"
          ]
        },
        "maximum_amount": "<string>",
        "line_items": [
          {
            "amount": "7.00",
            "discount": {
              "discount_type": "percentage",
              "applies_to_price_ids": [
                "h74gfhdjvn7ujokd",
                "7hfgtgjnbvc3ujkl"
              ],
              "reason": "<string>",
              "percentage_discount": 0.15
            },
            "end_date": "2022-02-01T08:00:00+00:00",
            "grouping": "<string>",
            "minimum": {
              "minimum_amount": "<string>",
              "applies_to_price_ids": [
                "<string>"
              ]
            },
            "minimum_amount": "<string>",
            "maximum": {
              "maximum_amount": "<string>",
              "applies_to_price_ids": [
                "<string>"
              ]
            },
            "maximum_amount": "<string>",
            "adjustments": [
              {
                "id": "<string>",
                "is_invoice_level": true,
                "applies_to_price_ids": [
                  "<string>"
                ],
                "reason": "<string>",
                "adjustment_type": "usage_discount",
                "usage_discount": 123,
                "amount": "<string>"
              }
            ],
            "name": "Fixed Fee",
            "quantity": 1,
            "start_date": "2022-02-01T08:00:00+00:00",
            "subtotal": "9.00",
            "adjusted_subtotal": "5.00",
            "credits_applied": "6.00",
            "partially_invoiced_amount": "4.00",
            "sub_line_items": [
              {
                "amount": "9.00",
                "name": "Tier One",
                "quantity": 5,
                "grouping": {
                  "key": "region",
                  "value": "west"
                },
                "type": "matrix",
                "matrix_config": {
                  "dimension_values": [
                    "<string>"
                  ]
                }
              }
            ],
            "tax_amounts": [
              {
                "tax_rate_description": "<string>",
                "tax_rate_percentage": "<string>",
                "amount": "<string>"
              }
            ],
            "id": "<string>",
            "price": {
              "metadata": {},
              "id": "<string>",
              "name": "<string>",
              "external_price_id": "<string>",
              "price_type": "usage_price",
              "model_type": "unit",
              "created_at": "2023-11-07T05:31:56Z",
              "cadence": "one_time",
              "billing_cycle_configuration": {
                "duration": 123,
                "duration_unit": "day"
              },
              "invoicing_cycle_configuration": {
                "duration": 123,
                "duration_unit": "day"
              },
              "billable_metric": {
                "id": "<string>"
              },
              "dimensional_price_configuration": {
                "dimensional_price_group_id": "<string>",
                "dimension_values": [
                  "<string>"
                ]
              },
              "fixed_price_quantity": 123,
              "plan_phase_order": 123,
              "currency": "<string>",
              "conversion_rate": 123,
              "item": {
                "id": "<string>",
                "name": "<string>"
              },
              "credit_allocation": {
                "currency": "<string>",
                "allows_rollover": true
              },
              "discount": {
                "discount_type": "percentage",
                "applies_to_price_ids": [
                  "h74gfhdjvn7ujokd",
                  "7hfgtgjnbvc3ujkl"
                ],
                "reason": "<string>",
                "percentage_discount": 0.15
              },
              "minimum": {
                "minimum_amount": "<string>",
                "applies_to_price_ids": [
                  "<string>"
                ]
              },
              "minimum_amount": "<string>",
              "maximum": {
                "maximum_amount": "<string>",
                "applies_to_price_ids": [
                  "<string>"
                ]
              },
              "maximum_amount": "<string>",
              "unit_config": {
                "unit_amount": "<string>"
              }
            },
            "usage_customer_ids": [
              "<string>"
            ],
            "filter": "<string>"
          }
        ],
        "subscription": {
          "id": "VDGsT23osdLb84KD"
        },
        "subtotal": "8.00",
        "total": "8.00",
        "customer_balance_transactions": [
          {
            "id": "cgZa3SXcsPTVyC4Y",
            "created_at": "2022-05-01T07:01:31+00:00",
            "starting_balance": "33.00",
            "ending_balance": "22.00",
            "amount": "11.00",
            "action": "applied_to_invoice",
            "description": "An optional description",
            "invoice": {
              "id": "gXcsPTVyC4YZa3Sc"
            },
            "type": "increment",
            "credit_note": {
              "id": "<string>"
            }
          }
        ],
        "status": "issued",
        "invoice_source": "subscription",
        "shipping_address": {
          "line1": "<string>",
          "line2": "<string>",
          "city": "<string>",
          "state": "<string>",
          "postal_code": "<string>",
          "country": "<string>"
        },
        "billing_address": {
          "line1": "<string>",
          "line2": "<string>",
          "city": "<string>",
          "state": "<string>",
          "postal_code": "<string>",
          "country": "<string>"
        },
        "hosted_invoice_url": "<string>",
        "will_auto_issue": true,
        "eligible_to_issue_at": "2023-11-07T05:31:56Z",
        "customer_tax_id": {
          "country": "AD",
          "type": "ad_nrt",
          "value": "<string>"
        },
        "memo": "<string>",
        "credit_notes": [
          {
            "id": "<string>",
            "credit_note_number": "<string>",
            "reason": "<string>",
            "total": "<string>",
            "voided_at": "2022-05-01T07:01:31+00:00",
            "type": "<string>",
            "memo": "<string>"
          }
        ],
        "payment_attempts": [
          {
            "id": "<string>",
            "payment_provider": "stripe",
            "payment_provider_id": "<string>",
            "amount": "<string>",
            "succeeded": true,
            "created_at": "2023-11-07T05:31:56Z"
          }
        ],
        "invoice_date": "2022-05-01T07:00:00+00:00"
      }
    ]
  }
}

Authorizations

​
Authorization
string
header
required

API Keys can be issued in the Orb's web application.

Path Parameters

​
subscription_id
string
required

Body

application/json
​
cancel_option
enum<string>
required

Determines the timing of subscription cancellation

Available options:
end_of_subscription_term,
immediate,
requested_date
​
cancellation_date
string | null

The date that the cancellation should take effect. This parameter can only be passed if the cancel_option is requested_date.

​
allow_invoice_credit_or_void
boolean | null
default:true

If false, this request will fail if it would void an issued invoice or create a credit note. Consider using this as a safety mechanism if you do not expect existing invoices to be changed.

Response

200
application/json
OK
​
metadata
object
required

User specified key-value pairs for the resource. If not present, this defaults to an empty dictionary. Individual keys can be removed by setting the value to null, and the entire metadata mapping can be cleared by setting metadata to null.

​
id
string
required
​
customer
object
required

A customer is a buyer of your products, and the other party to the billing relationship.

In Orb, customers are assigned system generated identifiers automatically, but it's often desirable to have these match existing identifiers in your system. To avoid having to denormalize Orb ID information, you can pass in an external_customer_id with your own identifier. See Customer ID Aliases for further information about how these aliases work in Orb.

In addition to having an identifier in your system, a customer may exist in a payment provider solution like Stripe. Use the payment_provider_id and the payment_provider enum field to express this mapping.

A customer also has a timezone (from the standard IANA timezone database), which defaults to your account's timezone. See Timezone localization for information on what this timezone parameter influences within Orb.

​
plan
object
required

The Plan resource represents a plan that can be subscribed to by a customer. Plans define the billing behavior of the subscription. You can see more about how to configure prices in the Price resource.

​
start_date
string
required

The date Orb starts billing for this subscription.

​
end_date
string | null
required

The date Orb stops billing for this subscription.

​
created_at
string
required
​
current_billing_period_start_date
string | null
required

The start date of the current billing period. This is an inclusive timestamp; the instant returned is exactly the beginning of the billing period. Set to null if the subscription is not currently active.

​
current_billing_period_end_date
string | null
required

The end of the current billing period. This is an exclusive timestamp, such that the instant returned is not part of the billing period. Set to null for subscriptions that are not currently active.

​
status
enum<string>
required
Available options:
active,
ended,
upcoming
​
trial_info
object
required
​
active_plan_phase_order
integer | null
required

The current plan phase that is active, only if the subscription's plan has phases.

​
fixed_fee_quantity_schedule
object[]
required
​
default_invoice_memo
string | null
required

Determines the default memo on this subscriptions' invoices. Note that if this is not provided, it is determined by the plan configuration.

​
auto_collection
boolean | null
required

Determines whether issued invoices for this subscription will automatically be charged with the saved payment method on the due date. This property defaults to the plan's behavior. If null, defaults to the customer's setting.

​
net_terms
integer
required

Determines the difference between the invoice issue date for subscription invoices as the date that they are due. A value of 0 here represents that the invoice is due on issue, whereas a value of 30 represents that the customer has a month to pay the invoice.

​
redeemed_coupon
object | null
required
​
billing_cycle_day
integer
required

The day of the month on which the billing cycle is anchored. If the maximum number of days in a month is greater than this value, the last day of the month is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing period begins on the 30th.

Required range: 1 <= x <= 31
​
billing_cycle_anchor_configuration
object
required
​
invoicing_threshold
string | null
required
​
price_intervals
object[]
required

The price intervals for this subscription.

The Price Interval resource represents a period of time for which a price will bill on a subscription. A subscription’s price intervals define its billing behavior.

​
adjustment_intervals
object[]
required

The adjustment intervals for this subscription sorted by the start_date of the adjustment interval.

​
discount_intervals
object[]
required

The discount intervals for this subscription sorted by the start_date.

​
minimum_intervals
object[]
required

The minimum intervals for this subscription sorted by the start_date.

​
maximum_intervals
object[]
required

The maximum intervals for this subscription sorted by the start_date.

​
pending_subscription_change
object | null
required

A pending subscription change if one exists on this subscription.

​
changed_resources
object | null

The resources that were changed as part of this operation. Only present when fetched through the subscription changes API or if the include_changed_resources parameter was passed in the request.

Was this page helpful?