Update subscription product quantities | Resemble

curl -X PATCH https://app.resemble.ai/billing/api/v1/subscription/products \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "changes": [
    {
      "product_slug": "voice_clone",
      "new_quantity": 5
    },
    {
      "product_slug": "another_adjustable_product",
      "new_quantity": 10
    }
  ]
}'

{
  "subscription": {
    "id": 1,
    "plan": {
      "id": 1,
      "name": "string",
      "slug": "string",
      "plan_type": "self_serve",
      "base_fee_cents": 1,
      "base_fee_dollars": 1.1,
      "total_base_cost_cents": 1,
      "total_base_cost_dollars": 1.1,
      "included_dollar_balance_cents": 1,
      "included_dollar_balance_dollars": 1.1,
      "billing_interval": "monthly",
      "plan_family": {
        "key": "string",
        "name": "string",
        "description": "string",
        "position": 1
      },
      "active": true,
      "products": [
        {
          "id": 1,
          "name": "string",
          "slug": "string",
          "description": "string",
          "unit_type": "string",
          "category": "metered",
          "rate_per_unit_cents": 1,
          "rate_per_unit_dollars": 1.1,
          "has_tiers": true,
          "tiers": [
            {
              "tier_order": 1,
              "min_quantity": 1.1,
              "max_quantity": 1.1,
              "rate_per_unit_cents": 1,
              "rate_per_unit_dollars": 1.1
            }
          ],
          "included_quantity": 1.1,
          "allow_additional_usage": true,
          "min_usage_per_period": 1.1,
          "max_usage_per_period": 1.1,
          "ui_visible": true,
          "product_family": {
            "key": "string",
            "name": "string",
            "description": "string",
            "position": 1
          }
        }
      ],
      "created_at": "2024-01-15T09:30:00Z",
      "updated_at": "2024-01-15T09:30:00Z"
    },
    "status": "pending_payment",
    "current_period_start": "2024-01-15T09:30:00Z",
    "current_period_end": "2024-01-15T09:30:00Z",
    "cancel_at_period_end": true,
    "cancel_at": "2024-01-15T09:30:00Z",
    "activated_at": "2024-01-15T09:30:00Z",
    "invoice_due_date": "2023-01-15",
    "delinquent_at": "2024-01-15T09:30:00Z",
    "subscription_items": [
      {
        "id": 1,
        "quantity": 1.1,
        "consumed_quantity": 1.1,
        "product": {
          "id": 1,
          "name": "string",
          "slug": "string",
          "unit_type": "string",
          "category": "metered",
          "description": "string",
          "active": true,
          "min_purchase_quantity": 1.1,
          "max_purchase_quantity": 1.1
        },
        "plan_product": {
          "included_quantity": 1.1,
          "allow_additional_usage": true,
          "min_usage_per_period": 1.1,
          "max_usage_per_period": 1.1
        },
        "rate_per_unit_cents": 1.1,
        "current_rate_per_unit_cents": 1.1,
        "is_grandfathered": true,
        "rate_locked_at": "2024-01-15T09:30:00Z",
        "ui_visible": true
      }
    ],
    "created_at": "2024-01-15T09:30:00Z",
    "updated_at": "2024-01-15T09:30:00Z"
  }
}

Updates one or more adjustable subscription products atomically. Each new_quantity is the desired absolute total, not an increment. A product is adjustable when its category is subscription and its plan_product.allow_additional_usage value is true. Quantities must remain within the plan’s minimum and maximum and cannot be reduced below consumed_quantity.

Updates one or more adjustable subscription products atomically. Each `new_quantity` is the desired absolute total, not an increment. A product is adjustable when its category is `subscription` and its `plan_product.allow_additional_usage` value is true. Quantities must remain within the plan's minimum and maximum and cannot be reduced below `consumed_quantity`.

Authentication

AuthorizationBearer

API key from https://app.resemble.ai/hub/api

Request

This endpoint expects an object.

changeslist of objectsRequired

Response

Subscription with updated product quantities.

subscriptionobject or null

Errors

400

Bad Request Error

401

Unauthorized Error

402

Payment Required Error

403

Forbidden Error

404

Not Found Error

422

Unprocessable Entity Error

500

Internal Server Error