SubscriptionGroupSignupResponse

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/maxio/json-schema/maxio-subscription-group-signup-response-schema.json",
  "title": "SubscriptionGroupSignupResponse",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/maxio-advanced-billing-openapi.yml#/components/schemas/SubscriptionGroupSignupResponse",
  "type": "object",
  "properties": {
    "uid": {
      "type": "string"
    },
    "scheme": {
      "type": "integer",
      "contentEncoding": "int32"
    },
    "customer_id": {
      "type": "integer",
      "contentEncoding": "int32"
    },
    "payment_profile_id": {
      "type": "integer",
      "contentEncoding": "int32"
    },
    "subscription_ids": {
      "type": "array",
      "items": {
        "type": "integer",
        "contentEncoding": "int32"
      },
      "description": ""
    },
    "primary_subscription_id": {
      "type": "integer",
      "contentEncoding": "int32"
    },
    "next_assessment_at": {
      "type": "string",
      "contentEncoding": "date-time"
    },
    "state": {
      "allOf": [
        {
          "$ref": "#/$defs/SubscriptionState"
        },
        {
          "description": "The state of a subscription.\n* **Live States**\n    * `active` - A normal, active subscription. It is not in a trial and is paid and up to date.\n    * `assessing` - An internal (transient) state that indicates a subscription is in the middle of periodic assessment. Do not base any access decisions in your app on this state, as it may not always be exposed.\n    * `pending` - An internal (transient) state that indicates a subscription is in the creation process. Do not base any access decisions in your app on this state, as it may not always be exposed.\n    * `trialing` - A subscription in trialing state has a valid trial subscription. This type of subscription may transition to active once payment is received when the trial has ended. Otherwise, it may go to a Problem or End of Life state.\n    * `paused` - An internal state that indicates that your account with Advanced Billing is in arrears.\n* **Problem States**\n    * `past_due` - Indicates that the most recent payment has failed, and payment is past due for this subscription. If you have enabled our automated dunning, this subscription will be in the dunning process (additional status and callbacks from the dunning process will be available in the future). If you are handling dunning and payment updates yourself, you will want to use this state to initiate a payment update from your customers.\n    * `soft_failure` - Indicates that normal assessment/processing of the subscription has failed for a reason that cannot be fixed by the Customer. For example, a Soft Fail may result from a timeout at the gateway or incorrect credentials on your part. The subscriptions should be retried automatically. An interface is being built for you to review problems resulting from these events to take manual action when needed.\n    * `unpaid` - Indicates an unpaid subscription. A subscription is marked unpaid if the retry period expires and you have configured your [Dunning](https://docs.maxio.com/billing/subscriptions/dunning/overview/understanding-how-dunning-works) settings to have a Final Action of `mark the subscription unpaid`.\n* **End of Life States**\n    * `canceled` - Indicates a canceled subscription. This may happen at your request (via the API or the web interface) or due to the expiration of the [Dunning](https://docs.maxio.com/billing/subscriptions/dunning/overview/understanding-how-dunning-works) process without payment. See the [Reactivation](https://docs.maxio.com/billing/subscriptions/management/state-management/understand-reactivation-and-resume-scenarios) documentation for info on how to restart a canceled subscription.\n    While a subscription is canceled, its period will not advance, it will not accrue any new charges, and Advanced Billing will not attempt to collect the overdue balance.\n    * `expired` - Indicates a subscription that has expired due to running its normal life cycle. Some products may be configured to have an expiration period. An expired subscription then is one that stayed active until it fulfilled its full period.\n    * `failed_to_create` - Indicates that signup has failed. (You may see this state in a signup_failure webhook.)\n    * `on_hold` - Indicates that a subscription’s billing has been temporarily stopped. While it is expected that the subscription will resume and return to active status, this is still treated as an “End of Life” state because the customer is not paying for services during this time.\n    * `suspended` - Indicates that a prepaid subscription has used up all their prepayment balance. If a prepayment is applied, it will return to an active state.\n    * `trial_ended` - A subscription in a trial_ended state is a subscription that completed a no-obligation trial and did not have a card on file at the expiration of the trial period. See [Product Pricing – No Obligation Trials](https://docs.maxio.com/billing/catalog/plans/creating-plans) for more details.\n\nSee [Subscription States](https://docs.maxio.com/billing/subscriptions/management/subscription-states/understand-subscription-states) for more info about subscription states and state transitions."
        }
      ]
    },
    "cancel_at_end_of_period": {
      "type": "boolean"
    },
    "subscriptions": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/SubscriptionGroupItem"
      },
      "description": ""
    },
    "payment_collection_method": {
      "allOf": [
        {
          "$ref": "#/$defs/CollectionMethod"
        },
        {
          "description": "The type of payment collection to be used in the subscription. For legacy Statements Architecture valid options are - `invoice`, `automatic`. For current Relationship Invoicing Architecture valid options are - `remittance`, `automatic`, `prepaid`."
        }
      ]
    }
  },
  "$defs": {
    "CollectionMethod": {
      "title": "CollectionMethod",
      "enum": [
        "automatic",
        "remittance",
        "prepaid",
        "invoice"
      ],
      "type": "string",
      "description": "The type of payment collection to be used in the subscription. For legacy Statements Architecture valid options are - `invoice`, `automatic`. For current Relationship Invoicing Architecture valid options are - `remittance`, `automatic`, `prepaid`."
    },
    "SubscriptionGroupItem": {
      "title": "SubscriptionGroupItem",
      "type": "object",
      "properties": {
        "id": {
          "type": "integer",
          "contentEncoding": "int32"
        },
        "reference": {
          "type": [
            "string",
            "null"
          ]
        },
        "product_id": {
          "type": "integer",
          "contentEncoding": "int32"
        },
        "product_handle": {
          "type": [
            "string",
            "null"
          ]
        },
        "product_price_point_id": {
          "type": "integer",
          "contentEncoding": "int32"
        },
        "product_price_point_handle": {
          "type": "string"
        },
        "currency": {
          "type": "string"
        },
        "coupon_code": {
          "type": [
            "string",
            "null"
          ]
        },
        "total_revenue_in_cents": {
          "type": "integer",
          "contentEncoding": "int64"
        },
        "balance_in_cents": {
          "type": "integer",
          "contentEncoding": "int64"
        }
      }
    },
    "SubscriptionState": {
      "title": "SubscriptionState",
      "enum": [
        "pending",
        "failed_to_create",
        "trialing",
        "assessing",
        "active",
        "soft_failure",
        "past_due",
        "suspended",
        "canceled",
        "expired",
        "paused",
        "unpaid",
        "trial_ended",
        "on_hold",
        "awaiting_signup"
      ],
      "type": "string",
      "description": "The state of a subscription.\n* **Live States**\n    * `active` - A normal, active subscription. It is not in a trial and is paid and up to date.\n    * `assessing` - An internal (transient) state that indicates a subscription is in the middle of periodic assessment. Do not base any access decisions in your app on this state, as it may not always be exposed.\n    * `pending` - An internal (transient) state that indicates a subscription is in the creation process. Do not base any access decisions in your app on this state, as it may not always be exposed.\n    * `trialing` - A subscription in trialing state has a valid trial subscription. This type of subscription may transition to active once payment is received when the trial has ended. Otherwise, it may go to a Problem or End of Life state.\n    * `paused` - An internal state that indicates that your account with Advanced Billing is in arrears.\n* **Problem States**\n    * `past_due` - Indicates that the most recent payment has failed, and payment is past due for this subscription. If you have enabled our automated dunning, this subscription will be in the dunning process (additional status and callbacks from the dunning process will be available in the future). If you are handling dunning and payment updates yourself, you will want to use this state to initiate a payment update from your customers.\n    * `soft_failure` - Indicates that normal assessment/processing of the subscription has failed for a reason that cannot be fixed by the Customer. For example, a Soft Fail may result from a timeout at the gateway or incorrect credentials on your part. The subscriptions should be retried automatically. An interface is being built for you to review problems resulting from these events to take manual action when needed.\n    * `unpaid` - Indicates an unpaid subscription. A subscription is marked unpaid if the retry period expires and you have configured your [Dunning](https://docs.maxio.com/billing/subscriptions/dunning/overview/understanding-how-dunning-works) settings to have a Final Action of `mark the subscription unpaid`.\n* **End of Life States**\n    * `canceled` - Indicates a canceled subscription. This may happen at your request (via the API or the web interface) or due to the expiration of the [Dunning](https://docs.maxio.com/billing/subscriptions/dunning/overview/understanding-how-dunning-works) process without payment. See the [Reactivation](https://docs.maxio.com/billing/subscriptions/management/state-management/understand-reactivation-and-resume-scenarios) documentation for info on how to restart a canceled subscription.\n    While a subscription is canceled, its period will not advance, it will not accrue any new charges, and Advanced Billing will not attempt to collect the overdue balance.\n    * `expired` - Indicates a subscription that has expired due to running its normal life cycle. Some products may be configured to have an expiration period. An expired subscription then is one that stayed active until it fulfilled its full period.\n    * `failed_to_create` - Indicates that signup has failed. (You may see this state in a signup_failure webhook.)\n    * `on_hold` - Indicates that a subscription’s billing has been temporarily stopped. While it is expected that the subscription will resume and return to active status, this is still treated as an “End of Life” state because the customer is not paying for services during this time.\n    * `suspended` - Indicates that a prepaid subscription has used up all their prepayment balance. If a prepayment is applied, it will return to an active state.\n    * `trial_ended` - A subscription in a trial_ended state is a subscription that completed a no-obligation trial and did not have a card on file at the expiration of the trial period. See [Product Pricing – No Obligation Trials](https://docs.maxio.com/billing/catalog/plans/creating-plans) for more details.\n\nSee [Subscription States](https://docs.maxio.com/billing/subscriptions/management/subscription-states/understand-subscription-states) for more info about subscription states and state transitions."
    }
  }
}