Stigg API Client

https://python-sdk-docs.stigg.io/
Admin
Stigg API Client is a Python SDK for integrating Stigg's subscription and billing management...
Tokens:3,460,975
Snippets:11,575
Trust Score:8
Update:7 months ago
Show doc for...
Tokens:
Raw
### Subscription Start Setup

Source: https://python-sdk-docs.stigg.io/stigg.generated.GetWorkflowTriggersInput

Represents the initial setup configuration for a subscription.

```APIDOC
## Subscription Start Setup

### Description
Defines the configuration for initiating a new subscription.

### Endpoint
N/A (This is a data type, not an endpoint)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (N/A)
N/A

#### Response Example
None

**Type:**
- `SubscriptionStartSetup`
```

--------------------------------

### Provisioning

Source: https://python-sdk-docs.stigg.io/stigg.generated.DoesFeatureExist

Documentation for provisioning customers and subscriptions, including input and fragment structures.

```APIDOC
## Provisioning Data Structures

### Description
Structures related to provisioning customers and subscriptions, including various input and fragment representations.

### Data Structures

#### ProrationBehavior
Defines the behavior for proration.

#### ProvisionCustomer
Represents the result of provisioning a customer.

#### ProvisionCustomerFragment
Fragment representing a provisioned customer.

#### ProvisionCustomerFragmentCustomer
Represents customer details within a provisioned customer fragment.

#### ProvisionCustomerFragmentEntitlements
Represents entitlements for a provisioned customer.

#### ProvisionCustomerFragmentEntitlementsV2CreditEntitlement
Represents v2 credit entitlements for a provisioned customer.

#### ProvisionCustomerFragmentEntitlementsV2FeatureEntitlement
Represents v2 feature entitlements for a provisioned customer.

#### ProvisionCustomerFragmentSubscription
Represents subscription details for a provisioned customer.

#### ProvisionCustomerInput
Input structure for provisioning a customer.

#### ProvisionCustomerProvisionCustomer
Nested structure for provisioning a customer.

#### ProvisionCustomerSubscriptionInput
Input structure for provisioning a customer's subscription.

#### ProvisionSandboxInput
Input structure for provisioning a sandbox environment.

#### ProvisionSubscription
Represents the result of provisioning a subscription.

#### ProvisionSubscriptionFragment
Fragment representing a provisioned subscription.

#### ProvisionSubscriptionFragmentEntitlements
Represents entitlements for a provisioned subscription.

#### ProvisionSubscriptionFragmentEntitlementsV2CreditEntitlement
Represents v2 credit entitlements for a provisioned subscription.

#### ProvisionSubscriptionFragmentEntitlementsV2FeatureEntitlement
Represents v2 feature entitlements for a provisioned subscription.

#### ProvisionSubscriptionFragmentSubscription
Represents subscription details within a provisioned subscription fragment.

#### ProvisionSubscriptionInput
Input structure for provisioning a subscription.

#### ProvisionSubscriptionProvisionSubscription
Nested structure for provisioning a subscription.

#### ProvisionSubscriptionStatus
Represents the status of a provisioned subscription.
```

--------------------------------

### Subscription Start Setup

Source: https://python-sdk-docs.stigg.io/stigg.generated.AppStoreSubscriptionsToPlansMappingInput

Input structure for initiating the setup of a new subscription.

```APIDOC
## Subscription Start Setup

### Description
This structure is used to provide the necessary information to begin the setup process for a new subscription.

### Endpoint
N/A (Input Structure)

### Parameters
#### SubscriptionStartSetup
- **plan_id** (string) - Required - The ID of the plan for the new subscription.
- **customer_id** (string) - Required - The ID of the customer subscribing.
- **billing_period** (string) - Optional - The initial billing period (e.g., "monthly", "yearly"). Defaults to the plan's default.
- **addons** (array) - Optional - A list of addon IDs to include with the subscription.
- **coupon_id** (string) - Optional - The ID of a coupon to apply to the subscription.

### Response
N/A (Input Structure)
```

--------------------------------

### Subscription Provisioning and Preview Data Structures

Source: https://python-sdk-docs.stigg.io/stigg.generated.UsageMarkerType

Structures for provisioning new subscriptions, customers, and previewing subscription details.

```APIDOC
## Subscription Provisioning and Preview Data Structures

### Description
Structures used for provisioning customers and subscriptions, including various entitlement versions, and for previewing subscription-related information.

### Data Structures
- `ProrationBehavior`
- `ProvisionCustomer`
- `ProvisionCustomerFragment`
- `ProvisionCustomerFragmentCustomer`
- `ProvisionCustomerFragmentEntitlements`
- `ProvisionCustomerFragmentEntitlementsV2CreditEntitlement`
- `ProvisionCustomerFragmentEntitlementsV2FeatureEntitlement`
- `ProvisionCustomerFragmentSubscription`
- `ProvisionCustomerInput`
- `ProvisionCustomerProvisionCustomer`
- `ProvisionCustomerSubscriptionInput`
- `ProvisionSandboxInput`
- `ProvisionSubscription`
- `ProvisionSubscriptionFragment`
- `ProvisionSubscriptionFragmentEntitlements`
- `ProvisionSubscriptionFragmentEntitlementsV2CreditEntitlement`
- `ProvisionSubscriptionFragmentEntitlementsV2FeatureEntitlement`
- `ProvisionSubscriptionFragmentSubscription`
- `ProvisionSubscriptionInput`
- `ProvisionSubscriptionProvisionSubscription`
- `ProvisionSubscriptionStatus`
- `PublishMigrationType`
- `PublishOfferInput`
- `RecalculateEntitlementsInput`
- `RecalculateEntitlementsSideEffectsOptionsInput`
- `RemoveBasePlanFromPlanInput`
- `PreviewCreditGrantBillingInfoInput`
- `PreviewCreditGrantInput`
- `PreviewNextInvoice`
- `PreviewNextInvoiceInput`
- `PreviewNextInvoicePreviewNextInvoice`
- `PreviewSubscription`
- `PreviewSubscriptionInput`
- `PreviewSubscriptionPreviewSubscription`
```

--------------------------------

### Subscription Start Setup

Source: https://python-sdk-docs.stigg.io/stigg.generated.CustomerFragmentPromotionalEntitlements

Configuration for initiating a new subscription.

```APIDOC
## Subscription Start Setup

### Description
Input object used to configure the initial setup of a new subscription.

### Endpoint
N/A (This is an input structure)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
**SubscriptionStartSetup** (Object) - Contains parameters for starting a subscription.

### Request Example
```json
{
  "plan_code": "basic_monthly",
  "customer_id": "cust_12345"
}
```

### Response
#### Success Response (200)
N/A (This is an input structure)

#### Response Example
N/A
```

--------------------------------

### Sandbox and Subscription Provisioning

Source: https://python-sdk-docs.stigg.io/stigg.generated.PackageDTOFilter

Structures for provisioning sandbox environments and subscriptions.

```APIDOC
## Sandbox and Subscription Provisioning

### Description
Input structures for provisioning sandbox environments and subscription details.

### Data Structures
- `ProvisionSandboxInput`: Input object for provisioning a sandbox environment.
- `ProvisionSubscription`: Represents the result of provisioning a subscription.
- `ProvisionSubscriptionFragment`: Fragment containing subscription provisioning details.
- `ProvisionSubscriptionFragmentEntitlements`: Entitlements associated with the provisioned subscription.
- `ProvisionSubscriptionFragmentEntitlementsV2CreditEntitlement`: Specific credit entitlement within V2 entitlements.
- `ProvisionSubscriptionFragmentEntitlementsV2FeatureEntitlement`: Specific feature entitlement within V2 entitlements.
- `ProvisionSubscriptionFragmentSubscription`: Nested subscription details.
- `ProvisionSubscriptionInput`: Input object for provisioning a subscription.
```

--------------------------------

### Subscription Start and Status

Source: https://python-sdk-docs.stigg.io/stigg.generated.ListAwsProductDimensionsInput

Covers the initial setup for subscriptions and their various states.

```APIDOC
## SubscriptionStartSetup

### Description
Input object for initiating the setup of a new subscription.

### Method
N/A

### Endpoint
N/A

## SubscriptionStatus

### Description
Represents the current status of a subscription.

### Method
N/A

### Endpoint
N/A

## SubscriptionStatusFilterComparison

### Description
Defines comparison operators for filtering subscriptions by status.

### Method
N/A

### Endpoint
N/A
```

--------------------------------

### Provisioning and Subscriptions

Source: https://python-sdk-docs.stigg.io/stigg.generated.UpdateCreditGrantInput

Documentation for data structures related to provisioning customers and subscriptions, including input and fragment models.

```APIDOC
## Provisioning and Subscriptions Data Structures

### Description
Provides definitions for data structures related to provisioning customers and subscriptions, including various input and fragment models.

### Data Structures

#### ProrationBehavior
Specifies the behavior for proration.

#### ProvisionCustomer
Represents a provisioned customer.

#### ProvisionCustomerFragment
Fragment containing information about a provisioned customer.

#### ProvisionCustomerFragmentCustomer
Fragment detailing customer information within a provisioned customer fragment.

#### ProvisionCustomerFragmentEntitlements
Fragment detailing entitlements for a provisioned customer.

#### ProvisionCustomerFragmentEntitlementsV2CreditEntitlement
Represents a v2 credit entitlement within provisioned customer entitlements.

#### ProvisionCustomerFragmentEntitlementsV2FeatureEntitlement
Represents a v2 feature entitlement within provisioned customer entitlements.

#### ProvisionCustomerFragmentSubscription
Fragment detailing subscription information for a provisioned customer.

#### ProvisionCustomerInput
Input model for provisioning a customer.

#### ProvisionCustomerProvisionCustomer
Represents the result of provisioning a customer.

#### ProvisionCustomerSubscriptionInput
Input model for provisioning a customer's subscription.

#### ProvisionSandboxInput
Input model for provisioning a sandbox environment.

#### ProvisionSubscription
Represents a provisioned subscription.

#### ProvisionSubscriptionFragment
Fragment containing information about a provisioned subscription.

#### ProvisionSubscriptionFragmentEntitlements
Fragment detailing entitlements for a provisioned subscription.

#### ProvisionSubscriptionFragmentEntitlementsV2CreditEntitlement
Represents a v2 credit entitlement within provisioned subscription entitlements.

#### ProvisionSubscriptionFragmentEntitlementsV2FeatureEntitlement
Represents a v2 feature entitlement within provisioned subscription entitlements.

#### ProvisionSubscriptionFragmentSubscription
Fragment detailing subscription information within a provisioned subscription fragment.

#### ProvisionSubscriptionInput
Input model for provisioning a subscription.

#### ProvisionSubscriptionProvisionSubscription
Represents the result of provisioning a subscription.

#### ProvisionSubscriptionStatus
Represents the status of a provisioned subscription.

#### PublishMigrationType
Specifies the type of publish migration.
```

--------------------------------

### Subscription Provisioning

Source: https://python-sdk-docs.stigg.io/stigg.generated.report_event

Documentation for provisioning subscriptions, including fragments and input structures.

```APIDOC
## Subscription Provisioning

### Description
Structures related to provisioning subscriptions, including fragments for subscription data and input for provisioning operations.

### Data Structures

- **ProvisionSubscription** (object) - Represents a provisioned subscription.
- **ProvisionSubscriptionFragment** (object) - Represents a fragment of subscription data.
- **ProvisionSubscriptionFragmentEntitlements** (object) - Represents entitlements for a provisioned subscription.
- **ProvisionSubscriptionFragmentEntitlementsV2CreditEntitlement** (object) - Represents V2 credit entitlements.
- **ProvisionSubscriptionFragmentEntitlementsV2FeatureEntitlement** (object) - Represents V2 feature entitlements.
- **ProvisionSubscriptionFragmentSubscription** (object) - Represents subscription details within a fragment.
- **ProvisionSubscriptionInput** (object) - Input structure for provisioning a subscription.
- **ProvisionSubscriptionProvisionSubscription** (object) - Nested structure for the provisioned subscription.
- **ProvisionSubscriptionStatus** (enum) - Represents the status of a provisioned subscription.
```

--------------------------------

### Subscription Management

Source: https://python-sdk-docs.stigg.io/stigg.generated.MigrateSubscriptionToLatestMigrateSubscriptionToLatest

Types related to the lifecycle and configuration of subscriptions, including start setup, status, and trial configurations.

```APIDOC
## Subscription Management

### Description
Types for managing subscription lifecycles, statuses, and trial periods.

### Types
- `SubscriptionStartSetup`
- `SubscriptionStatus`
- `SubscriptionStatusFilterComparison`
- `SubscriptionTrialConfigurationFragment`
```

--------------------------------

### Subscription Management

Source: https://python-sdk-docs.stigg.io/stigg.generated.SubscriptionScheduledUpdateDataScheduleVariablesBillingPeriodChangeVariables

Covers various aspects of subscription management, including status, start setup, and usage cutoff behaviors.

```APIDOC
## Subscription Management

### Description
Provides structures for managing subscription states, initiation, and how usage data is handled upon updates.

### Endpoints
N/A (Data Structures)

### Data Structures
- **SubscriptionStartSetup**
- **SubscriptionStatus**
- **SubscriptionStatusFilterComparison**
- **SubscriptionUpdateUsageCutoffBehavior**
- **SubscriptionUpdateUsageResetCutoffRuleInput**
```

--------------------------------

### Sandbox and Subscription Provisioning

Source: https://python-sdk-docs.stigg.io/stigg.generated.CustomerPortalFragmentResource

Input structures for provisioning sandboxes and subscriptions.

```APIDOC
## Sandbox and Subscription Provisioning Structures

### Description
Input structures for provisioning sandbox environments and subscriptions, including entitlement details and status.

### Data Models

- **ProvisionSandboxInput**
- **ProvisionSubscription**
- **ProvisionSubscriptionFragment**
- **ProvisionSubscriptionFragmentEntitlements**
- **ProvisionSubscriptionFragmentEntitlementsV2CreditEntitlement**
- **ProvisionSubscriptionFragmentEntitlementsV2FeatureEntitlement**
- **ProvisionSubscriptionFragmentSubscription**
- **ProvisionSubscriptionInput**
- **ProvisionSubscriptionProvisionSubscription**
- **ProvisionSubscriptionStatus**
```

--------------------------------

### Preview and Preparation Structures

Source: https://python-sdk-docs.stigg.io/stigg.generated.GrantPromotionalEntitlementsGroupInput

Data structures for previewing and preparing various billing and subscription elements.

```APIDOC
## Preview and Preparation Data Structures

### Description
Defines data structures used for previewing invoices, subscriptions, and preparing payment methods.

### Data Structures

- **PreparePaymentMethodFormInput**: Input for preparing a payment method form.
- **PreviewCreditGrantBillingInfoInput**: Input for previewing credit grant billing information.
- **PreviewCreditGrantInput**: Input for previewing a credit grant.
- **PreviewNextInvoice**: Represents a preview of the next invoice.
- **PreviewNextInvoiceInput**: Input for previewing the next invoice.
- **PreviewNextInvoicePreviewNextInvoice**: Nested structure for previewing the next invoice.
- **PreviewSubscription**: Represents a preview of a subscription.
- **PreviewSubscriptionInput**: Input for previewing a subscription.
- **PreviewSubscriptionPreviewSubscription**: Nested structure for previewing a subscription.
```

--------------------------------

### Subscription Lifecycle Management

Source: https://python-sdk-docs.stigg.io/stigg.generated.AggregatedEventsByCustomerInput

API elements for managing the lifecycle of subscriptions, including start setup, status, and trial configurations.

```APIDOC
## Subscription Lifecycle Management

### Description
This section details the API components for managing the lifecycle of subscriptions, including initiating the setup process, defining subscription status, and configuring trial periods.

### Method
N/A (Data Structures)

### Endpoint
N/A (Data Structures)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **SubscriptionStartSetup** (Object) - Input for initiating the subscription setup process.
- **SubscriptionStatus** (Enum) - Represents the current status of a subscription (e.g., active, past_due, cancelled).
- **SubscriptionStatusFilterComparison** (Enum) - Defines comparison operators for filtering subscriptions by status.
- **SubscriptionTrialConfigurationFragment** (Object) - Configuration details for a subscription's trial period.

### Request Example
```json
{
  "trialPeriodDays": 30,
  "trialEndBehavior": "cancel"
}
```

### Response
#### Success Response (200)
N/A (Data Structures)

#### Response Example
N/A (Data Structures)
```

--------------------------------

### Provisioning and Subscriptions

Source: https://python-sdk-docs.stigg.io/stigg.generated.MemberSort

Documentation for data structures related to provisioning customers and subscriptions, including input and status.

```APIDOC
## Provisioning and Subscriptions API

### Description
This section details the data structures used for provisioning customers and subscriptions. It covers input formats for provisioning, subscription details, and status management.

### Method
N/A (Data Structures)

### Endpoint
N/A (Data Structures)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
**ProvisionCustomer** (Object) - Represents a customer provisioning operation.
**ProvisionCustomerFragment** (Object) - Fragment representing a provisioned customer.
**ProvisionCustomerFragmentCustomer** (Object) - Customer details within a provisioned customer fragment.
**ProvisionCustomerFragmentEntitlements** (Object) - Entitlements for a provisioned customer.
**ProvisionCustomerFragmentEntitlementsV2CreditEntitlement** (Object) - V2 credit entitlement details.
**ProvisionCustomerFragmentEntitlementsV2FeatureEntitlement** (Object) - V2 feature entitlement details.
**ProvisionCustomerFragmentSubscription** (Object) - Subscription details for a provisioned customer.
**ProvisionCustomerInput** (Object) - Input object for provisioning a customer.
**ProvisionCustomerProvisionCustomer** (Object) - Result of customer provisioning.
**ProvisionCustomerSubscriptionInput** (Object) - Input object for provisioning a customer's subscription.
**ProvisionSandboxInput** (Object) - Input object for provisioning a sandbox environment.
**ProvisionSubscription** (Object) - Represents a subscription provisioning operation.
**ProvisionSubscriptionFragment** (Object) - Fragment representing a provisioned subscription.
**ProvisionSubscriptionFragmentEntitlements** (Object) - Entitlements for a provisioned subscription.
**ProvisionSubscriptionFragmentEntitlementsV2CreditEntitlement** (Object) - V2 credit entitlement details.
**ProvisionSubscriptionFragmentEntitlementsV2FeatureEntitlement** (Object) - V2 feature entitlement details.
**ProvisionSubscriptionFragmentSubscription** (Object) - Subscription details within a provisioned subscription fragment.
**ProvisionSubscriptionInput** (Object) - Input object for provisioning a subscription.
**ProvisionSubscriptionProvisionSubscription** (Object) - Result of subscription provisioning.
**ProvisionSubscriptionStatus** (Enum) - Possible statuses for subscription provisioning.
**PublishMigrationType** (Enum) - Types of migration for publishing.
**PublishOfferInput** (Object) - Input object for publishing an offer.
**RecalculateEntitlementsInput** (Object) - Input object for recalculating entitlements.
**RecalculateEntitlementsSideEffectsOptionsInput** (Object) - Options for side effects of entitlement recalculation.
**RemoveBasePlanFromPlanInput** (Object) - Input object for removing a base plan from a plan.

### Request Example
```json
{
  "example": "ProvisionCustomerInput example"
}
```

### Response
#### Success Response (200)
**ProvisionCustomer** (Object) - Customer provisioning details.
**ProvisionCustomerFragment** (Object) - Provisioned customer fragment.
**ProvisionCustomerFragmentCustomer** (Object) - Customer details.
**ProvisionCustomerFragmentEntitlements** (Object) - Entitlements.
**ProvisionCustomerFragmentEntitlementsV2CreditEntitlement** (Object) - V2 credit entitlement.
**ProvisionCustomerFragmentEntitlementsV2FeatureEntitlement** (Object) - V2 feature entitlement.
**ProvisionCustomerFragmentSubscription** (Object) - Subscription details.
**ProvisionCustomerInput** (Object) - Customer provisioning input.
**ProvisionCustomerProvisionCustomer** (Object) - Customer provisioning result.
**ProvisionCustomerSubscriptionInput** (Object) - Customer subscription provisioning input.
**ProvisionSandboxInput** (Object) - Sandbox provisioning input.
**ProvisionSubscription** (Object) - Subscription provisioning details.
**ProvisionSubscriptionFragment** (Object) - Provisioned subscription fragment.
**ProvisionSubscriptionFragmentEntitlements** (Object) - Entitlements.
**ProvisionSubscriptionFragmentEntitlementsV2CreditEntitlement** (Object) - V2 credit entitlement.
**ProvisionSubscriptionFragmentEntitlementsV2FeatureEntitlement** (Object) - V2 feature entitlement.
**ProvisionSubscriptionFragmentSubscription** (Object) - Subscription details.
**ProvisionSubscriptionInput** (Object) - Subscription provisioning input.
**ProvisionSubscriptionProvisionSubscription** (Object) - Subscription provisioning result.
**ProvisionSubscriptionStatus** (Enum) - Provisioning status.
**PublishMigrationType** (Enum) - Migration type.
**PublishOfferInput** (Object) - Offer publishing input.
**RecalculateEntitlementsInput** (Object) - Entitlement recalculation input.
**RecalculateEntitlementsSideEffectsOptionsInput** (Object) - Side effects options.
**RemoveBasePlanFromPlanInput** (Object) - Input to remove base plan.

#### Response Example
```json
{
  "example": "ProvisionCustomerFragment example"
}
```
```

--------------------------------

### Subscription Management

Source: https://python-sdk-docs.stigg.io/stigg.generated.PlanCompatiblePackageGroupsFragment

Covers various aspects of subscription management, including start setup, status, trial configurations, updates, and cancellations.

```APIDOC
## Subscription Management

### Description
APIs and data structures for managing the lifecycle of subscriptions, from initial setup to updates and cancellations.

### Method
N/A (Data Structures)

### Endpoint
N/A (Data Structures)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```json
{
  "example": "SubscriptionStartSetup"
}
```

### Response
#### Success Response (200)
N/A (Data Structures)

#### Response Example
```json
{
  "example": "SubscriptionUpdateScheduleCancellationInput"
}
```
```

--------------------------------

### Subscription Management

Source: https://python-sdk-docs.stigg.io/stigg.generated.CreditBalanceUpdatedPayload

Covers various aspects of subscription management, including start setup, status, trial configurations, and update schedules.

```APIDOC
## Subscription Management

### Description
Data structures and enums related to managing subscriptions, including their initiation, status, trial periods, and update scheduling.

### Method
N/A (Data Structures)

### Endpoint
N/A (Data Structures)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
None

#### Response Example
None

## Specific Data Structures and Enums:

### `SubscriptionStartSetup`
- **Description**: Input structure for initiating a new subscription setup.

### `SubscriptionStatus`
- **Description**: Enum representing the current status of a subscription.

### `SubscriptionStatusFilterComparison`
- **Description**: Defines comparison operators for filtering subscriptions by status.

### `SubscriptionTrialConfigurationFragment`
- **Description**: Represents configuration details for a subscription's trial period.

### `SubscriptionUpdateScheduleCancellationInput`
- **Description**: Input structure for scheduling the cancellation of a subscription update.

### `SubscriptionUpdateUsageCutoffBehavior`
- **Description**: Defines the behavior for cutoff when updating subscription usage.

### `SubscriptionUpdateUsageResetCutoffRuleInput`
- **Description**: Input structure for defining rules to reset usage cutoff for subscription updates.
```

--------------------------------

### Subscription Provisioning and Preview

Source: https://python-sdk-docs.stigg.io/stigg.generated.PriceTierFragment

Structures for provisioning subscriptions, customers, and previewing subscription details and invoices.

```APIDOC
## Subscription Provisioning and Preview

### Description
Structures related to provisioning customers and subscriptions, including sandbox provisioning and previewing invoices and subscription states.

### Endpoint
N/A (Data Structures)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
None

#### Response Example
None

**Key Structures:**
- `ProrationBehavior`
- `ProvisionCustomer`
- `ProvisionCustomerFragment`
- `ProvisionCustomerFragmentCustomer`
- `ProvisionCustomerFragmentEntitlements`
- `ProvisionCustomerFragmentEntitlementsV2CreditEntitlement`
- `ProvisionCustomerFragmentEntitlementsV2FeatureEntitlement`
- `ProvisionCustomerFragmentSubscription`
- `ProvisionCustomerInput`
- `ProvisionCustomerProvisionCustomer`
- `ProvisionCustomerSubscriptionInput`
- `ProvisionSandboxInput`
- `ProvisionSubscription`
- `ProvisionSubscriptionFragment`
- `ProvisionSubscriptionFragmentEntitlements`
- `ProvisionSubscriptionFragmentEntitlementsV2CreditEntitlement`
- `ProvisionSubscriptionFragmentEntitlementsV2FeatureEntitlement`
- `ProvisionSubscriptionFragmentSubscription`
- `ProvisionSubscriptionInput`
- `ProvisionSubscriptionProvisionSubscription`
- `ProvisionSubscriptionStatus`
- `PublishOfferInput`
- `RecalculateEntitlementsInput`
- `RecalculateEntitlementsSideEffectsOptionsInput`
- `PreviewCreditGrantBillingInfoInput`
- `PreviewCreditGrantInput`
- `PreviewNextInvoice`
- `PreviewNextInvoiceInput`
- `PreviewNextInvoicePreviewNextInvoice`
- `PreviewSubscription`
- `PreviewSubscriptionInput`
- `PreviewSubscriptionPreviewSubscription`
```

--------------------------------

### Provisioning and Subscriptions

Source: https://python-sdk-docs.stigg.io/stigg.generated.CreateEnvironmentOptions

Data structures for provisioning customers and subscriptions, including entitlements and input parameters.

```APIDOC
## Provisioning and Subscriptions Data Structures

### Description
This section details the data structures used for provisioning customers and subscriptions, including entitlement details and various input formats.

### Data Structures
- **`ProrationBehavior`**: Enum defining proration behavior.
- **`ProvisionCustomer`**: Represents the provisioning of a customer.
- **`ProvisionCustomerFragment`**: Fragment for customer provisioning details.
- **`ProvisionCustomerFragmentCustomer`**: Customer details within a provision customer fragment.
- **`ProvisionCustomerFragmentEntitlements`**: Entitlements within a provision customer fragment.
- **`ProvisionCustomerFragmentEntitlementsV2CreditEntitlement`**: V2 credit entitlement within entitlements.
- **`ProvisionCustomerFragmentEntitlementsV2FeatureEntitlement`**: V2 feature entitlement within entitlements.
- **`ProvisionCustomerFragmentSubscription`**: Subscription details within a provision customer fragment.
- **`ProvisionCustomerInput`**: Input structure for provisioning a customer.
- **`ProvisionCustomerProvisionCustomer`**: Payload for provisioning a customer.
- **`ProvisionCustomerSubscriptionInput`**: Input structure for provisioning a customer's subscription.
- **`ProvisionSandboxInput`**: Input for provisioning a sandbox environment.
- **`ProvisionSubscription`**: Represents the provisioning of a subscription.
- **`ProvisionSubscriptionFragment`**: Fragment for subscription provisioning details.
- **`ProvisionSubscriptionFragmentEntitlements`**: Entitlements within a provision subscription fragment.
- **`ProvisionSubscriptionFragmentEntitlementsV2CreditEntitlement`**: V2 credit entitlement within subscription entitlements.
- **`ProvisionSubscriptionFragmentEntitlementsV2FeatureEntitlement`**: V2 feature entitlement within subscription entitlements.
- **`ProvisionSubscriptionFragmentSubscription`**: Subscription details within a provision subscription fragment.
- **`ProvisionSubscriptionInput`**: Input structure for provisioning a subscription.
- **`ProvisionSubscriptionProvisionSubscription`**: Payload for provisioning a subscription.
- **`ProvisionSubscriptionStatus`**: Enum representing the status of subscription provisioning.
```

--------------------------------

### Get Checkout State

Source: https://python-sdk-docs.stigg.io/nameIndex

Retrieves the current state of the checkout process for a customer. This is useful for tracking the progress of a purchase or subscription setup.

```APIDOC
## GET /checkout/state

### Description
Retrieves the current state of the checkout process for a customer. This is useful for tracking the progress of a purchase or subscription setup.

### Method
GET

### Endpoint
/checkout/state

### Parameters
#### Query Parameters
- **customer_id** (string) - Required - The ID of the customer.

### Request Example
```
GET /checkout/state?customer_id=cus_12345
```

### Response
#### Success Response (200)
- **state** (string) - The current state of the checkout process (e.g., 'in_progress', 'completed', 'failed').
- **checkout_id** (string) - The unique identifier for the checkout session.

#### Response Example
```json
{
  "state": "completed",
  "checkout_id": "chkt_abc789"
}
```
```

--------------------------------

### Subscription Provisioning and Management

Source: https://python-sdk-docs.stigg.io/stigg.generated.SubscriptionFragmentTotalPrice

This section details data structures for provisioning new customers and subscriptions, including handling entitlements and previewing changes.

```APIDOC
## Subscription Provisioning and Management Structures

### Description
These structures are used for provisioning customers and subscriptions, managing entitlements (including V2 versions), and previewing subscription-related information like invoices and changes.

### Data Structures

- **`ProrationBehavior`**: Defines the behavior for proration calculations.
- **`ProvisionCustomer`**: Represents the result of provisioning a customer.
- **`ProvisionCustomerFragment`**: Fragment containing customer provisioning details.
- **`ProvisionCustomerFragmentCustomer`**: Fragment detailing the provisioned customer.
- **`ProvisionCustomerFragmentEntitlements`**: Fragment detailing entitlements for a provisioned customer.
- **`ProvisionCustomerFragmentEntitlementsV2CreditEntitlement`**: Represents V2 credit entitlements for a provisioned customer.
- **`ProvisionCustomerFragmentEntitlementsV2FeatureEntitlement`**: Represents V2 feature entitlements for a provisioned customer.
- **`ProvisionCustomerFragmentSubscription`**: Fragment detailing the subscription associated with a provisioned customer.
- **`ProvisionCustomerInput`**: Input structure for provisioning a customer.
- **`ProvisionCustomerProvisionCustomer`**: Represents the provisioned customer object.
- **`ProvisionCustomerSubscriptionInput`**: Input structure for provisioning a customer's subscription.
- **`ProvisionSandboxInput`**: Input structure for provisioning a sandbox environment.
- **`ProvisionSubscription`**: Represents the result of provisioning a subscription.
- **`ProvisionSubscriptionFragment`**: Fragment containing subscription provisioning details.
- **`ProvisionSubscriptionFragmentEntitlements`**: Fragment detailing entitlements for a provisioned subscription.
- **`ProvisionSubscriptionFragmentEntitlementsV2CreditEntitlement`**: Represents V2 credit entitlements for a provisioned subscription.
- **`ProvisionSubscriptionFragmentEntitlementsV2FeatureEntitlement`**: Represents V2 feature entitlements for a provisioned subscription.
- **`ProvisionSubscriptionFragmentSubscription`**: Fragment detailing the provisioned subscription.
- **`ProvisionSubscriptionInput`**: Input structure for provisioning a subscription.
- **`ProvisionSubscriptionProvisionSubscription`**: Represents the provisioned subscription object.
- **`ProvisionSubscriptionStatus`**: Represents the status of a subscription provisioning operation.
- **`PublishMigrationType`**: Type of migration for publishing.
- **`PublishOfferInput`**: Input structure for publishing an offer.
- **`RecalculateEntitlementsInput`**: Input structure for recalculating entitlements.
- **`RecalculateEntitlementsSideEffectsOptionsInput`**: Options for side effects during entitlement recalculation.
- **`RemoveBasePlanFromPlanInput`**: Input structure for removing a base plan from a plan.
- **`PreparePaymentMethodFormInput`**: Input structure for preparing a payment method form.
- **`PreviewCreditGrantBillingInfoInput`**: Input structure for previewing credit grant billing information.
- **`PreviewCreditGrantInput`**: Input structure for previewing a credit grant.
- **`PreviewNextInvoice`**: Represents a preview of the next invoice.
- **`PreviewNextInvoiceInput`**: Input structure for previewing the next invoice.
- **`PreviewNextInvoicePreviewNextInvoice`**: Represents the preview of the next invoice.
- **`PreviewSubscription`**: Represents a preview of a subscription.
- **`PreviewSubscriptionInput`**: Input structure for previewing a subscription.
- **`PreviewSubscriptionPreviewSubscription`**: Represents the preview of a subscription.
```

--------------------------------

### Subscription Lifecycle Management

Source: https://python-sdk-docs.stigg.io/stigg.generated.SubscriptionPriceSortFields

Covers structures for managing the lifecycle of subscriptions, including start setup, status, trial configurations, and update schedules.

--------------------------------

### Subscription Lifecycle and Configuration

Source: https://python-sdk-docs.stigg.io/stigg.generated.ProvisionCustomerFragment

Documentation for classes related to the subscription lifecycle, including start setup, status, trial configurations, and update behaviors.

```APIDOC
## Subscription Lifecycle and Configuration

### Description
This documentation covers various aspects of the subscription lifecycle and its configuration. It includes details on how a subscription starts, its current status, trial period configurations, and how usage updates are handled.

### Method
N/A (Data Structures)

### Endpoint
N/A (Data Structures)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
None

#### Response Example
None

**Specific Classes:**
- `SubscriptionStartSetup`
- `SubscriptionStatus`
- `SubscriptionStatusFilterComparison`
- `SubscriptionTrialConfigurationFragment`
- `SubscriptionUpdateUsageCutoffBehavior`
- `SubscriptionUpdateUsageResetCutoffRuleInput`
```

--------------------------------

### Customer and Subscription Provisioning

Source: https://python-sdk-docs.stigg.io/stigg.generated.BillingModel

Documentation for provisioning customers and subscriptions, including related input and fragment structures.

```APIDOC
## Customer and Subscription Provisioning Data Structures

### Description
This section details the data structures involved in provisioning customers and subscriptions, including various input formats and detailed fragments.

### Data Structures

#### ProvisionCustomer
Represents the provisioning of a customer.

#### ProvisionCustomerFragment
Fragment containing details about a provisioned customer.

#### ProvisionCustomerFragmentCustomer
Customer details within a provisioned customer fragment.

#### ProvisionCustomerFragmentEntitlements
Entitlements for a provisioned customer.

#### ProvisionCustomerFragmentEntitlementsV2CreditEntitlement
Represents a v2 credit entitlement for a provisioned customer.

#### ProvisionCustomerFragmentEntitlementsV2FeatureEntitlement
Represents a v2 feature entitlement for a provisioned customer.

#### ProvisionCustomerFragmentSubscription
Subscription details for a provisioned customer.

#### ProvisionCustomerInput
Input structure for provisioning a customer.

#### ProvisionCustomerProvisionCustomer
Represents the result of customer provisioning.

#### ProvisionCustomerSubscriptionInput
Input structure for provisioning a customer's subscription.

#### ProvisionSandboxInput
Input structure for provisioning a sandbox environment.

#### ProvisionSubscription
Represents the provisioning of a subscription.

#### ProvisionSubscriptionFragment
Fragment containing details about a provisioned subscription.

#### ProvisionSubscriptionFragmentEntitlements
Entitlements for a provisioned subscription.

#### ProvisionSubscriptionFragmentEntitlementsV2CreditEntitlement
Represents a v2 credit entitlement for a provisioned subscription.

#### ProvisionSubscriptionFragmentEntitlementsV2FeatureEntitlement
Represents a v2 feature entitlement for a provisioned subscription.

#### ProvisionSubscriptionFragmentSubscription
Subscription details within a provisioned subscription fragment.

#### ProvisionSubscriptionInput
Input structure for provisioning a subscription.

#### ProvisionSubscriptionProvisionSubscription
Represents the result of subscription provisioning.

#### ProvisionSubscriptionStatus
Represents the status of subscription provisioning.

```

--------------------------------

### Subscription Lifecycle and Status Management

Source: https://python-sdk-docs.stigg.io/stigg.generated.NumberFieldComparison

Details on managing subscription lifecycles, including start setup, status, trial configurations, and update schedules.

```APIDOC
## Subscription Lifecycle and Status Management

### Description
This section outlines the data structures and enums related to the lifecycle of a subscription, including its initial setup, current status, trial configurations, and update scheduling.

### Method
N/A (These are data structures, not API endpoints)

### Endpoint
N/A

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
This section lists the available types:

- `SubscriptionStartSetup` (Input for initiating subscription setup)
- `SubscriptionStatus` (Enum for the current status of a subscription)
- `SubscriptionStatusFilterComparison` (Enum for comparing subscription statuses in filters)
- `SubscriptionTrialConfigurationFragment` (Fragment for configuring subscription trials)
- `SubscriptionUpdateScheduleCancellationInput` (Input for scheduling subscription cancellations)
- `SubscriptionUpdateUsageCutoffBehavior` (Defines behavior for usage cutoffs during updates)
- `SubscriptionUpdateUsageResetCutoffRuleInput` (Input for rules related to resetting usage cutoffs)

### Request Example
```json
{
  "example": "Refer to specific type definitions for detailed examples."
}
```

### Response
#### Success Response (200)
N/A (These are data structures, not API endpoints)

#### Response Example
```json
{
  "example": "Refer to specific type definitions for detailed examples."
}
```
```

--------------------------------

### Customer and Subscription Provisioning

Source: https://python-sdk-docs.stigg.io/stigg.generated.SubscriptionScheduledUpdateData

This section details data structures for provisioning customers and subscriptions, including fragments for detailed information and input models.

```APIDOC
## Customer and Subscription Provisioning Data Structures

### Description
Objects related to provisioning customers and subscriptions, including detailed fragments of customer and subscription information, and input models for provisioning requests.

### Data Structures

- **ProrationBehavior**
- **ProvisionCustomer**
- **ProvisionCustomerFragment**
- **ProvisionCustomerFragmentCustomer**
- **ProvisionCustomerFragmentEntitlements**
- **ProvisionCustomerFragmentEntitlementsV2CreditEntitlement**
- **ProvisionCustomerFragmentEntitlementsV2FeatureEntitlement**
- **ProvisionCustomerFragmentSubscription**
- **ProvisionCustomerInput**
- **ProvisionCustomerProvisionCustomer**
- **ProvisionCustomerSubscriptionInput**
- **ProvisionSandboxInput**
- **ProvisionSubscription**
- **ProvisionSubscriptionFragment**
- **ProvisionSubscriptionFragmentEntitlements**
- **ProvisionSubscriptionFragmentEntitlementsV2CreditEntitlement**
- **ProvisionSubscriptionFragmentEntitlementsV2FeatureEntitlement**
- **ProvisionSubscriptionFragmentSubscription**
- **ProvisionSubscriptionInput**
- **ProvisionSubscriptionProvisionSubscription**
- **ProvisionSubscriptionStatus**
- **PublishMigrationType**
```

--------------------------------

### Subscription Management

Source: https://python-sdk-docs.stigg.io/stigg.generated.CustomerPortalSubscriptionPriceFragment

Covers various aspects of subscription management, including start setup, status, trial configurations, update schedules, and usage cutoff behaviors.

```APIDOC
## Subscription Management Structures

### Description
Structures related to initiating, managing, and updating subscriptions, including trial periods and usage cutoff rules.

### Endpoint
N/A (Data Structures)

### Parameters
None

### Request Example
None

### Response
None

**Data Structures:**
- `SubscriptionStartSetup`
- `SubscriptionStatus`
- `SubscriptionStatusFilterComparison`
- `SubscriptionTrialConfigurationFragment`
- `SubscriptionUpdateScheduleCancellationInput`
- `SubscriptionUpdateUsageCutoffBehavior`
- `SubscriptionUpdateUsageResetCutoffRuleInput`
```

--------------------------------

### Subscription Provisioning and Preview

Source: https://python-sdk-docs.stigg.io/stigg.generated.StopExperimentInput

Covers structures for provisioning customers and subscriptions, including previews and recalculations.

```APIDOC
## Subscription Provisioning and Preview

### Description
Data structures for provisioning customers and subscriptions, generating previews of invoices and subscriptions, and recalculating entitlements.

### Types
- `ProrationBehavior`
- `ProvisionCustomer`
- `ProvisionCustomerFragment`
- `ProvisionCustomerFragmentCustomer`
- `ProvisionCustomerFragmentEntitlements`
- `ProvisionCustomerFragmentEntitlementsV2CreditEntitlement`
- `ProvisionCustomerFragmentEntitlementsV2FeatureEntitlement`
- `ProvisionCustomerFragmentSubscription`
- `ProvisionCustomerInput`
- `ProvisionCustomerProvisionCustomer`
- `ProvisionCustomerSubscriptionInput`
- `ProvisionSandboxInput`
- `ProvisionSubscription`
- `ProvisionSubscriptionFragment`
- `ProvisionSubscriptionFragmentEntitlements`
- `ProvisionSubscriptionFragmentEntitlementsV2CreditEntitlement`
- `ProvisionSubscriptionFragmentEntitlementsV2FeatureEntitlement`
- `ProvisionSubscriptionFragmentSubscription`
- `ProvisionSubscriptionInput`
- `ProvisionSubscriptionProvisionSubscription`
- `ProvisionSubscriptionStatus`
- `PublishMigrationType`
- `PublishOfferInput`
- `RecalculateEntitlementsInput`
- `RecalculateEntitlementsSideEffectsOptionsInput`
```

--------------------------------

### Customer and Subscription Provisioning

Source: https://python-sdk-docs.stigg.io/stigg.generated.ClearCustomerPersistentCacheInput

This section details models for provisioning customers and subscriptions, including input and fragment data.

```APIDOC
## Customer and Subscription Provisioning

### Description
This section details models for provisioning customers and subscriptions, including input and fragment data.

### Data Models

#### `ProrationBehavior`
Represents the behavior of proration.

#### `ProvisionCustomer`
Represents the provisioning of a customer.

#### `ProvisionCustomerFragment`
Fragment representing a provisioned customer.

#### `ProvisionCustomerFragmentCustomer`
Represents the customer within a provisioned customer fragment.

#### `ProvisionCustomerFragmentEntitlements`
Represents entitlements within a provisioned customer fragment.

#### `ProvisionCustomerFragmentEntitlementsV2CreditEntitlement`
Represents a V2 credit entitlement within provisioned customer entitlements.

#### `ProvisionCustomerFragmentEntitlementsV2FeatureEntitlement`
Represents a V2 feature entitlement within provisioned customer entitlements.

#### `ProvisionCustomerFragmentSubscription`
Represents a subscription within a provisioned customer fragment.

#### `ProvisionCustomerInput`
Input model for provisioning a customer.

#### `ProvisionCustomerProvisionCustomer`
Represents the customer provisioning within a provision operation.

#### `ProvisionCustomerSubscriptionInput`
Input model for provisioning a customer's subscription.

#### `ProvisionSandboxInput`
Input model for provisioning a sandbox.

#### `ProvisionSubscription`
Represents the provisioning of a subscription.

#### `ProvisionSubscriptionFragment`
Fragment representing a provisioned subscription.

#### `ProvisionSubscriptionFragmentEntitlements`
Represents entitlements within a provisioned subscription fragment.

#### `ProvisionSubscriptionFragmentEntitlementsV2CreditEntitlement`
Represents a V2 credit entitlement within provisioned subscription entitlements.

#### `ProvisionSubscriptionFragmentEntitlementsV2FeatureEntitlement`
Represents a V2 feature entitlement within provisioned subscription entitlements.

#### `ProvisionSubscriptionFragmentSubscription`
Represents the subscription within a provisioned subscription fragment.

#### `ProvisionSubscriptionInput`
Input model for provisioning a subscription.

#### `ProvisionSubscriptionProvisionSubscription`
Represents the subscription provisioning within a provision operation.

#### `ProvisionSubscriptionStatus`
Represents the status of a provisioned subscription.

#### `PublishMigrationType`
Represents the type of publish migration.
```

--------------------------------

### Subscription Setup and Trials

Source: https://python-sdk-docs.stigg.io/stigg.generated.get_customer_statistics

Details on subscription setup configurations and trial management.

```APIDOC
## Subscription Setup and Trials

### Description
This section provides information on the initial setup of subscriptions and the configuration of trial periods.

### Data Structures

- **`SubscriptionStartSetup`**: Configuration for starting a new subscription.
- **`SubscriptionTrialConfigurationFragment`**: A fragment for configuring subscription trial periods.
- **`TrialEndBehavior`**: Defines the behavior when a trial period ends.
- **`TrialOverrideConfigurationInput`**: Input for overriding trial configurations.
- **`TrialPeriodUnits`**: Specifies the units for a trial period (e.g., days, weeks).
```

--------------------------------

### Subscription Setup and Status

Source: https://python-sdk-docs.stigg.io/stigg.generated.SourceType

Data structures for subscription setup and status, including filters.

```APIDOC
## Subscription Setup and Status

### Description
This section details data structures related to the initial setup of a subscription and its current status, including filtering options.

### Data Structures

#### SubscriptionStartSetup
- **Type**: Object
- **Description**: Represents the initial setup configuration for a subscription.

#### SubscriptionStatus
- **Type**: Enum
- **Description**: Represents the possible statuses of a subscription.

#### SubscriptionStatusFilterComparison
- **Type**: Enum
- **Description**: Defines comparison operators for filtering subscriptions by status.

### Response Example
```json
{
  "example": "SubscriptionStatus.ACTIVE"
}
```
```

--------------------------------

### Customer and Subscription Provisioning Structures

Source: https://python-sdk-docs.stigg.io/stigg.generated.CreditBalanceSummaryInput

Details structures for provisioning customers and subscriptions, including associated fragments, entitlements, and input/update objects.

```APIDOC
## Customer and Subscription Provisioning Structures

### Description
This section outlines the data structures used for provisioning customers and subscriptions, including detailed fragments for customer and subscription data, entitlement information, and input/update mechanisms.

### Data Structures

#### `ProrationBehavior`
- **Description**: Defines the behavior for proration during subscription changes.

#### `ProvisionCustomer`
- **Description**: Represents the result of provisioning a customer.

#### `ProvisionCustomerFragment`
- **Description**: Represents a fragment of provisioned customer data.

#### `ProvisionCustomerFragmentCustomer`
- **Description**: Represents customer details within a provisioned customer fragment.

#### `ProvisionCustomerFragmentEntitlements`
- **Description**: Represents entitlements for a provisioned customer.

#### `ProvisionCustomerFragmentEntitlementsV2CreditEntitlement`
- **Description**: Represents V2 credit entitlements for a provisioned customer.

#### `ProvisionCustomerFragmentEntitlementsV2FeatureEntitlement`
- **Description**: Represents V2 feature entitlements for a provisioned customer.

#### `ProvisionCustomerFragmentSubscription`
- **Description**: Represents subscription details within a provisioned customer fragment.

#### `ProvisionCustomerInput`
- **Description**: Input structure for provisioning a customer.

#### `ProvisionCustomerProvisionCustomer`
- **Description**: Represents the outcome of a customer provisioning operation.

#### `ProvisionCustomerSubscriptionInput`
- **Description**: Input structure for provisioning a subscription for a customer.

#### `ProvisionSandboxInput`
- **Description**: Input structure for provisioning a sandbox environment.

#### `ProvisionSubscription`
- **Description**: Represents the result of provisioning a subscription.

#### `ProvisionSubscriptionFragment`
- **Description**: Represents a fragment of provisioned subscription data.

#### `ProvisionSubscriptionFragmentEntitlements`
- **Description**: Represents entitlements for a provisioned subscription.

#### `ProvisionSubscriptionFragmentEntitlementsV2CreditEntitlement`
- **Description**: Represents V2 credit entitlements for a provisioned subscription.

#### `ProvisionSubscriptionFragmentEntitlementsV2FeatureEntitlement`
- **Description**: Represents V2 feature entitlements for a provisioned subscription.

#### `ProvisionSubscriptionFragmentSubscription`
- **Description**: Represents subscription details within a provisioned subscription fragment.

#### `ProvisionSubscriptionInput`
- **Description**: Input structure for provisioning a subscription.

#### `ProvisionSubscriptionProvisionSubscription`
- **Description**: Represents the outcome of a subscription provisioning operation.

#### `ProvisionSubscriptionStatus`
- **Description**: Represents the status of a subscription provisioning operation.

#### `PublishMigrationType`
- **Description**: Defines the type of migration for publishing.
```

--------------------------------

### Sandbox Provisioning

Source: https://python-sdk-docs.stigg.io/stigg.generated.AppStoreSubscriptionMappingInput

Details the input structure for provisioning a sandbox environment.

```APIDOC
## Sandbox Provisioning

### Description
Defines the input required for provisioning a sandbox environment, likely for testing purposes.

### Data Structures

#### ProvisionSandboxInput
Input model for provisioning a sandbox.
```

--------------------------------

### Subscription Setup and Status

Source: https://python-sdk-docs.stigg.io/stigg.generated.GetSdkConfiguration

Structures for initiating subscription setup and defining subscription statuses.

```APIDOC
## Subscription Setup and Status

### Description
Defines the input for setting up a subscription and the possible states of a subscription.

### Endpoint
N/A (Data Structures & Enums)

### Parameters

#### SubscriptionStartSetup
- **plan_id** (string) - Required - The ID of the plan to start the subscription with.
- **customer_id** (string) - Required - The ID of the customer.
- **coupon_id** (string) - Optional - The ID of a coupon to apply.
- **billing_period** (string) - Optional - The billing period for the subscription (e.g., 'monthly', 'yearly').
- **addons** (array) - Optional - A list of addon IDs to include.
- **billable_features** (array) - Optional - A list of billable feature IDs to include.
- **price_overrides** (array) - Optional - A list of price override configurations.

#### SubscriptionStatus
- **ACTIVE**: The subscription is active.
- **PAUSED**: The subscription is paused.
- **CANCELLED**: The subscription is cancelled.
- **TRIALING**: The subscription is in its trial period.
- **PAST_DUE**: The subscription payment is past due.

#### SubscriptionStatusFilterComparison
- **EQUALS**: Equal to the specified status.
- **NOT_EQUALS**: Not equal to the specified status.

### Response
N/A (Data Structures & Enums)
```
Tokens:
Raw