# Orb Subscription API

**Canonical:** https://apis.io/apis/orb-billing/orb-billing-subscription-api/  
**Provider:** Orb — https://apis.io/providers/orb-billing/  
**Base URL:** https://api.withorb.com/v1  
**Documentation:** https://docs.withorb.com/api-reference/customer

Orb Subscription API is one of 32 APIs that [Orb](https://apis.io/providers/orb-billing/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include Subscription. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, and API documentation.

A [subscription](/core-concepts#subscription) represents the purchase of a plan by a customer. By default, subscriptions begin on the day that they're created and renew automatically for each billing cycle at the cadence that's configured in the plan definition. Subscriptions also default to **beginning of month alignment**, which means the first invoice issued for the subscription will have pro-rated charges between the `start_date` and the first of the following month. Subsequent billing periods will always start and end on a month boundary (e.g. subsequent month starts for monthly billing). Depending on the plan configuration, any _flat_ recurring fees will be billed either at the beginning (in-advance) or end (in-arrears) of each billing cycle. Plans default to **in-advance billing**. Usage-based fees are billed in arrears as usage is accumulated. In the normal course of events, you can expect an invoice to contain usage-based charges for the previous period, and a recurring fee for the following period.

## Operations (17)

| Method | Path | Summary |
|---|---|---|
| GET | `/subscriptions` | List subscriptions |
| POST | `/subscriptions` | Create subscription |
| GET | `/subscriptions/summary` | List subscription summaries |
| GET | `/subscriptions/{subscription_id}` | Fetch subscription |
| PUT | `/subscriptions/{subscription_id}` | Update subscription |
| POST | `/subscriptions/{subscription_id}/cancel` | Cancel subscription |
| GET | `/subscriptions/{subscription_id}/costs` | Fetch subscription costs |
| POST | `/subscriptions/{subscription_id}/redeem_coupon` | Redeem Coupon |
| GET | `/subscriptions/{subscription_id}/schedule` | Fetch subscription schedule |
| POST | `/subscriptions/{subscription_id}/schedule_plan_change` | Schedule plan change |
| POST | `/subscriptions/{subscription_id}/trigger_phase` | Trigger phase |
| POST | `/subscriptions/{subscription_id}/unschedule_cancellation` | Unschedule subscription cancellation |
| POST | `/subscriptions/{subscription_id}/unschedule_fixed_fee_quantity_updates` | Unschedule fixed fee quantity updates |
| POST | `/subscriptions/{subscription_id}/unschedule_pending_plan_changes` | Unschedule plan change |
| POST | `/subscriptions/{subscription_id}/update_fixed_fee_quantity` | Update price quantity |
| POST | `/subscriptions/{subscription_id}/update_trial` | Update trial for subscription |
| GET | `/subscriptions/{subscription_id}/usage` | Fetch subscription usage |

## Machine-readable artifacts (13)

- **OpenAPI** — https://artifacts.apis.io/orb-billing/openapi/orb-billing-subscription-api-openapi.yml
- **APIReference** — https://docs.withorb.com/api-reference/customer
- **PostmanCollection** — https://artifacts.apis.io/orb-billing/collections/orb-billing.postman_collection.json
- **APIReference** — https://docs.withorb.com/api-reference/plan
- **APIReference** — https://docs.withorb.com/api-reference/subscription
- **Documentation** — https://docs.withorb.com/events-and-metrics/event-ingestion
- **APIReference** — https://docs.withorb.com/api-reference/event
- **Documentation** — https://docs.withorb.com/invoicing/structure
- **APIReference** — https://docs.withorb.com/api-reference/invoice
- **APIReference** — https://docs.withorb.com/api-reference/credit
- **APIReference** — https://docs.withorb.com/api-reference/price
- **APIReference** — https://docs.withorb.com/api-reference/alert
- **Documentation** — https://docs.withorb.com/guides/integrations-and-exports/webhooks

## Other Orb APIs (12)

- [Orb Alerts API](https://apis.io/apis/orb-billing/orb-billing-alerts-api/)
- [Orb Credits API](https://apis.io/apis/orb-billing/orb-billing-credits-api/)
- [Orb Events API](https://apis.io/apis/orb-billing/orb-billing-events-api/)
- [Orb Accounting sync webhooks API](https://apis.io/apis/orb-billing/orb-billing-accounting-sync-webhooks-api/)
- [Orb Alert API](https://apis.io/apis/orb-billing/orb-billing-alert-api/)
- [Orb Automation webhooks API](https://apis.io/apis/orb-billing/orb-billing-automation-webhooks-api/)
- [Orb Availability API](https://apis.io/apis/orb-billing/orb-billing-availability-api/)
- [Orb Coupon API](https://apis.io/apis/orb-billing/orb-billing-coupon-api/)
- [Orb Credit API](https://apis.io/apis/orb-billing/orb-billing-credit-api/)
- [Orb Credit note API](https://apis.io/apis/orb-billing/orb-billing-credit-note-api/)
- [Orb Customer API](https://apis.io/apis/orb-billing/orb-billing-customer-api/)
- [Orb Customer webhooks API](https://apis.io/apis/orb-billing/orb-billing-customer-webhooks-api/)

## Tags

Subscription

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/orb-billing/orb-billing-subscription-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/orb-billing/.