--- title: "Update subscription" method: PATCH path: "/api/v1/subscriptions/{subscription_id}" tags: ["Subscriptions"] --- # Update subscription `PATCH /api/v1/subscriptions/{subscription_id}` Update subscription settings like payment configuration, billing options, etc. ## Path parameters - `subscription_id` string, MeteroidId, required ## Request body - SubscriptionUpdateRequest - `auto_advance_invoices` boolean, nullable — If false, invoices will stay in Draft until manually reviewed and finalized. - `charge_automatically` boolean, nullable — Automatically try to charge the customer's configured payment method on finalize. - `invoice_memo` string, nullable — Default memo for invoices - `net_terms` integer, nullable — Payment terms in days (0 = due on issue) - `payment_methods_config` union — Online (card/direct debit), BankTransfer, or External. - OnlinePaymentMethodConfig - `config` OnlineMethodsConfig - `card` OnlineMethodConfig - `enabled` boolean, required - `direct_debit` OnlineMethodConfig - `enabled` boolean, required - BankTransferPaymentMethodConfig - `account_id` string, MeteroidId - ExternalPaymentMethodConfig - `purchase_order` string, nullable — Purchase order number ## Response `200` Subscription updated - SubscriptionUpdateResponse - `subscription` SubscriptionDetails, required - `activated_at` string, date-time, nullable — When the subscription was activated (first payment or activation condition met) - `add_ons` SubscriptionAddOn[], required - `add_on_id` string, MeteroidId - `fee` union, required - RateFee - `rate` string, decimal, required - OneTimeFee - `quantity` integer, required - `rate` string, decimal, required - RecurringFee - `billing_type` 'ADVANCE' | 'ARREARS', required - `quantity` integer, required - `rate` string, decimal, required - CapacityFee - `included` integer, required - `metric_id` string, MeteroidId, required - `overage_rate` string, decimal, required - `rate` string, decimal, required - SlotFee - `initial_slots` integer, required - `max_slots` integer, nullable - `min_slots` integer, nullable - `unit` string, required - `unit_rate` string, decimal, required - UsageFee - `metric_id` string, MeteroidId, required - `model` union, required - PerUnitPricing - … - TieredPricing - … - VolumePricing - … - PackagePricing - … - MatrixPricing - … - `id` string, MeteroidId - `name` string, required - `period` 'ONE_TIME' | 'MONTHLY' | 'QUARTERLY' | 'SEMIANNUAL' | 'ANNUAL', required - `quantity` integer, required - `applied_coupons` AppliedCouponDetailed[], required - `applied_coupon` AppliedCoupon, required - `applied_amount` string, decimal, nullable - `applied_count` integer, nullable - `coupon_id` string, MeteroidId, required - `created_at` string, date-time, required - `id` string, MeteroidId, required - `is_active` boolean, required - `last_applied_at` string, date-time, nullable - `coupon` SubscriptionCoupon, required — Coupon as embedded in subscription details — a subset of the `Coupon` resource returned by the coupons API. - `code` string, required - `description` string, required - `disabled` boolean, required - `discount` union, required - PercentageDiscount - `percentage` string, required - FixedDiscount - `amount` string, required - `currency` string, required - `expires_at` string, date-time, nullable - `id` string, MeteroidId, required - `recurring_value` integer, nullable - `redemption_limit` integer, nullable - `reusable` boolean, required - `auto_advance_invoices` boolean, required - `billing_day_anchor` integer, required - `billing_start_date` string, date, nullable — When billing started (after any trial period) - `charge_automatically` boolean, required - `checkout_url` string, nullable - `components` SubscriptionComponent[], required - `fee` union, required - RateFee - `rate` string, decimal, required - OneTimeFee - `quantity` integer, required - `rate` string, decimal, required - RecurringFee - `billing_type` 'ADVANCE' | 'ARREARS', required - `quantity` integer, required - `rate` string, decimal, required - CapacityFee - `included` integer, required - `metric_id` string, MeteroidId, required - `overage_rate` string, decimal, required - `rate` string, decimal, required - SlotFee - `initial_slots` integer, required - `max_slots` integer, nullable - `min_slots` integer, nullable - `unit` string, required - `unit_rate` string, decimal, required - UsageFee - `metric_id` string, MeteroidId, required - `model` union, required - PerUnitPricing - … - TieredPricing - … - VolumePricing - … - PackagePricing - … - MatrixPricing - … - `name` string, required - `period` 'ONE_TIME' | 'MONTHLY' | 'QUARTERLY' | 'SEMIANNUAL' | 'ANNUAL', required - `price_component_id` string, MeteroidId - `product_id` string, MeteroidId - `created_at` string, date-time, required — When the subscription was created - `currency` 'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHF' | 'CLP' | 'CNH' | 'CNY' | 'COP' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STD' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'UYU' | 'UZS' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XCD' | 'XOF' | 'XPF' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL', required - `current_period_end` string, date, nullable — Current billing period end date - `current_period_start` string, date, required — Current billing period start date - `customer_alias` string, nullable - `customer_id` string, MeteroidId, required - `customer_name` string, required - `end_date` string, date, nullable — When the subscription ends (if set) - `entitlements` Entitlement[] - `created_at` string, date-time, required - `feature_id` string, MeteroidId, required - `id` string, MeteroidId, required - `updated_at` string, date-time, required - `value` union, required - BooleanEntitlementValue - `enabled` boolean, required - MeteredEntitlementValue - `enabled` boolean — Per-entitlement kill switch. `false` means disabled. - `limit` string, decimal, nullable — Cap on usage. Null means unlimited. - `reset_period` union - BillingCycleResetPeriod — Resets each time your subscription renews — anchored to your billing cycle. - CalendarResetPeriod — Resets on calendar boundaries (e.g. the 1st of every month) — not tied to subscription start date. - … - FixedWindowResetPeriod — Resets at regular intervals — anchored to your subscription's exact activation time. - … - SlidingWindowResetPeriod — Always ends at now — e.g. 30 days means the last 30 days, old usage drops off automatically. - … - NeverResetPeriod — Never resets — counts all usage since the subscription was activated. - `id` string, MeteroidId, required - `invoice_memo` string, nullable — Default memo for invoices - `mrr_cents` integer, required — Monthly recurring revenue in cents - `net_terms` integer, required — Payment terms in days (0 = due on issue) - `payment_methods_config` union — Online (card/direct debit), BankTransfer, or External. - OnlinePaymentMethodConfig - `config` OnlineMethodsConfig - `card` OnlineMethodConfig - `enabled` boolean, required - `direct_debit` OnlineMethodConfig - `enabled` boolean, required - BankTransferPaymentMethodConfig - `account_id` string, MeteroidId - ExternalPaymentMethodConfig - `period` 'MONTHLY' | 'QUARTERLY' | 'SEMIANNUAL' | 'ANNUAL', required - `plan_id` string, MeteroidId, required - `plan_name` string, required - `plan_version` integer, required - `plan_version_id` string, MeteroidId, required - `purchase_order` string, nullable - `start_date` string, date, required — When the subscription contract starts (benefits apply from this date) - `status` 'PENDING_ACTIVATION' | 'PENDING_CHARGE' | 'TRIAL_ACTIVE' | 'ACTIVE' | 'TRIAL_EXPIRED' | 'PAUSED' | 'SUSPENDED' | 'CANCELLED' | 'COMPLETED' | 'SUPERSEDED' | 'ERRORED', required - `trial_duration` integer, nullable — Trial duration in days ## Other responses - `400` — Bad request - `401` — Unauthorized - `404` — Subscription not found - `429` — Too many requests - `500` — Internal error ## Changes > 54 revisions in range; 50 could not be searched. - **2025-07-09** (v1) `dece17f86f99` — 1 breaking - api removed without deprecation [Change history](https://skmtc.dev/meteroid-oss/apis/meteroid/changes/api/v1/subscriptions/:subscription_id/patch.md) --- [API](https://skmtc.dev/meteroid-oss/apis/meteroid.md) · [All operations](https://skmtc.dev/meteroid-oss/apis/meteroid/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/meteroid-oss/meteroid/revisions/03f9d8ae5c5e/schema)