Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. Stripe Provider
  4. API Docs
  5. Subscription
Viewing docs for Stripe 0.3.0
published on Friday, Aug 14, 2026 by Pulumi
Schema (JSON)
stripe/terraform-provider-stripe

stripe.Subscription

Viewing docs for Stripe 0.3.0
published on Friday, Aug 14, 2026 by Pulumi
Schema (JSON)
stripe/terraform-provider-stripe

    Subscriptions allow you to charge a customer on a recurring basis.

    Related guide: Creating subscriptions

    Create Subscription Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Subscription(name: string, args?: SubscriptionArgs, opts?: CustomResourceOptions);
    @overload
def Subscription(resource_name: str,
                 args: Optional[SubscriptionArgs] = None,
                 opts: Optional[ResourceOptions] = None)

@overload
def Subscription(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 add_invoice_items: Optional[Sequence[SubscriptionAddInvoiceItemArgs]] = None,
                 application_fee_percent: Optional[float] = None,
                 automatic_tax: Optional[SubscriptionAutomaticTaxArgs] = None,
                 backdate_start_date: Optional[float] = None,
                 billing_cycle_anchor: Optional[float] = None,
                 billing_cycle_anchor_config: Optional[SubscriptionBillingCycleAnchorConfigArgs] = None,
                 billing_mode: Optional[SubscriptionBillingModeArgs] = None,
                 billing_schedules: Optional[Sequence[SubscriptionBillingScheduleArgs]] = None,
                 billing_thresholds: Optional[SubscriptionBillingThresholdsArgs] = None,
                 cancel_at: Optional[float] = None,
                 cancel_at_period_end: Optional[bool] = None,
                 cancellation_details: Optional[SubscriptionCancellationDetailsArgs] = None,
                 collection_method: Optional[str] = None,
                 currency: Optional[str] = None,
                 customer: Optional[str] = None,
                 customer_account: Optional[str] = None,
                 days_until_due: Optional[float] = None,
                 default_payment_method: Optional[str] = None,
                 default_source: Optional[str] = None,
                 default_tax_rates: Optional[Sequence[str]] = None,
                 description: Optional[str] = None,
                 discounts: Optional[Sequence[SubscriptionDiscountArgs]] = None,
                 invoice_settings: Optional[SubscriptionInvoiceSettingsArgs] = None,
                 items: Optional[Sequence[SubscriptionItemArgs]] = None,
                 metadata: Optional[Mapping[str, str]] = None,
                 off_session: Optional[bool] = None,
                 on_behalf_of: Optional[str] = None,
                 pause_collection: Optional[SubscriptionPauseCollectionArgs] = None,
                 payment_behavior: Optional[str] = None,
                 payment_settings: Optional[SubscriptionPaymentSettingsArgs] = None,
                 pending_invoice_item_interval: Optional[SubscriptionPendingInvoiceItemIntervalArgs] = None,
                 proration_behavior: Optional[str] = None,
                 transfer_data: Optional[SubscriptionTransferDataArgs] = None,
                 trial_end: Optional[float] = None,
                 trial_from_plan: Optional[bool] = None,
                 trial_period_days: Optional[float] = None,
                 trial_settings: Optional[SubscriptionTrialSettingsArgs] = None)
    func NewSubscription(ctx *Context, name string, args *SubscriptionArgs, opts ...ResourceOption) (*Subscription, error)
    public Subscription(string name, SubscriptionArgs? args = null, CustomResourceOptions? opts = null)
    public Subscription(String name, SubscriptionArgs args)
public Subscription(String name, SubscriptionArgs args, CustomResourceOptions options)

    type: stripe:Subscription
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.


    resource "stripe_subscription" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args SubscriptionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args SubscriptionArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args SubscriptionArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SubscriptionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SubscriptionArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var subscriptionResource = new Stripe.Subscription("subscriptionResource", new()
{
    AddInvoiceItems = new[]
    {
        new Stripe.Inputs.SubscriptionAddInvoiceItemArgs
        {
            Discountable = false,
            Discounts = new[]
            {
                new Stripe.Inputs.SubscriptionAddInvoiceItemDiscountArgs
                {
                    Coupon = "string",
                    Discount = "string",
                    PromotionCode = "string",
                },
            },
            Metadata = 
            {
                { "string", "string" },
            },
            Period = new Stripe.Inputs.SubscriptionAddInvoiceItemPeriodArgs
            {
                End = new Stripe.Inputs.SubscriptionAddInvoiceItemPeriodEndArgs
                {
                    Type = "string",
                    Timestamp = 0.0,
                },
                Start = new Stripe.Inputs.SubscriptionAddInvoiceItemPeriodStartArgs
                {
                    Type = "string",
                    Timestamp = 0.0,
                },
            },
            Price = "string",
            PriceData = new Stripe.Inputs.SubscriptionAddInvoiceItemPriceDataArgs
            {
                Currency = "string",
                Product = "string",
                TaxBehavior = "string",
                UnitAmount = 0.0,
                UnitAmountDecimal = 0.0,
            },
            Quantity = 0.0,
            TaxRates = new[]
            {
                "string",
            },
        },
    },
    ApplicationFeePercent = 0.0,
    AutomaticTax = new Stripe.Inputs.SubscriptionAutomaticTaxArgs
    {
        Enabled = false,
        DisabledReason = "string",
        Liability = new Stripe.Inputs.SubscriptionAutomaticTaxLiabilityArgs
        {
            Type = "string",
            Account = "string",
        },
    },
    BackdateStartDate = 0.0,
    BillingCycleAnchor = 0.0,
    BillingCycleAnchorConfig = new Stripe.Inputs.SubscriptionBillingCycleAnchorConfigArgs
    {
        DayOfMonth = 0.0,
        Hour = 0.0,
        Minute = 0.0,
        Month = 0.0,
        Second = 0.0,
    },
    BillingMode = new Stripe.Inputs.SubscriptionBillingModeArgs
    {
        Type = "string",
        Flexible = new Stripe.Inputs.SubscriptionBillingModeFlexibleArgs
        {
            ProrationDiscounts = "string",
        },
        UpdatedAt = 0.0,
    },
    BillingSchedules = new[]
    {
        new Stripe.Inputs.SubscriptionBillingScheduleArgs
        {
            BillUntil = new Stripe.Inputs.SubscriptionBillingScheduleBillUntilArgs
            {
                Type = "string",
                ComputedTimestamp = 0.0,
                Duration = new Stripe.Inputs.SubscriptionBillingScheduleBillUntilDurationArgs
                {
                    Interval = "string",
                    IntervalCount = 0.0,
                },
                Timestamp = 0.0,
            },
            AppliesTos = new[]
            {
                new Stripe.Inputs.SubscriptionBillingScheduleAppliesToArgs
                {
                    Type = "string",
                    Price = "string",
                },
            },
            Key = "string",
        },
    },
    BillingThresholds = new Stripe.Inputs.SubscriptionBillingThresholdsArgs
    {
        AmountGte = 0.0,
        ResetBillingCycleAnchor = false,
    },
    CancelAt = 0.0,
    CancelAtPeriodEnd = false,
    CancellationDetails = new Stripe.Inputs.SubscriptionCancellationDetailsArgs
    {
        Comment = "string",
        Feedback = "string",
        Reason = "string",
    },
    CollectionMethod = "string",
    Currency = "string",
    Customer = "string",
    CustomerAccount = "string",
    DaysUntilDue = 0.0,
    DefaultPaymentMethod = "string",
    DefaultSource = "string",
    DefaultTaxRates = new[]
    {
        "string",
    },
    Description = "string",
    Discounts = new[]
    {
        new Stripe.Inputs.SubscriptionDiscountArgs
        {
            Coupon = "string",
            Discount = "string",
            PromotionCode = "string",
        },
    },
    InvoiceSettings = new Stripe.Inputs.SubscriptionInvoiceSettingsArgs
    {
        AccountTaxIds = new[]
        {
            "string",
        },
        Issuer = new Stripe.Inputs.SubscriptionInvoiceSettingsIssuerArgs
        {
            Type = "string",
            Account = "string",
        },
    },
    Items = new[]
    {
        new Stripe.Inputs.SubscriptionItemArgs
        {
            BillingThresholds = new Stripe.Inputs.SubscriptionItemBillingThresholdsArgs
            {
                UsageGte = 0.0,
            },
            Discounts = new[]
            {
                new Stripe.Inputs.SubscriptionItemDiscountArgs
                {
                    Coupon = "string",
                    Discount = "string",
                    PromotionCode = "string",
                },
            },
            Id = "string",
            Metadata = 
            {
                { "string", "string" },
            },
            Price = "string",
            PriceData = new Stripe.Inputs.SubscriptionItemPriceDataArgs
            {
                Currency = "string",
                Product = "string",
                Recurring = new Stripe.Inputs.SubscriptionItemPriceDataRecurringArgs
                {
                    Interval = "string",
                    IntervalCount = 0.0,
                },
                TaxBehavior = "string",
                UnitAmount = 0.0,
                UnitAmountDecimal = 0.0,
            },
            Quantity = 0.0,
            TaxRates = new[]
            {
                "string",
            },
        },
    },
    Metadata = 
    {
        { "string", "string" },
    },
    OffSession = false,
    OnBehalfOf = "string",
    PauseCollection = new Stripe.Inputs.SubscriptionPauseCollectionArgs
    {
        Behavior = "string",
        ResumesAt = 0.0,
    },
    PaymentBehavior = "string",
    PaymentSettings = new Stripe.Inputs.SubscriptionPaymentSettingsArgs
    {
        PaymentMethodOptions = new Stripe.Inputs.SubscriptionPaymentSettingsPaymentMethodOptionsArgs
        {
            AcssDebit = new Stripe.Inputs.SubscriptionPaymentSettingsPaymentMethodOptionsAcssDebitArgs
            {
                MandateOptions = new Stripe.Inputs.SubscriptionPaymentSettingsPaymentMethodOptionsAcssDebitMandateOptionsArgs
                {
                    TransactionType = "string",
                },
                VerificationMethod = "string",
            },
            Bancontact = new Stripe.Inputs.SubscriptionPaymentSettingsPaymentMethodOptionsBancontactArgs
            {
                PreferredLanguage = "string",
            },
            Card = new Stripe.Inputs.SubscriptionPaymentSettingsPaymentMethodOptionsCardArgs
            {
                MandateOptions = new Stripe.Inputs.SubscriptionPaymentSettingsPaymentMethodOptionsCardMandateOptionsArgs
                {
                    Amount = 0.0,
                    AmountType = "string",
                    Description = "string",
                },
                Network = "string",
                RequestThreeDSecure = "string",
            },
            CustomerBalance = new Stripe.Inputs.SubscriptionPaymentSettingsPaymentMethodOptionsCustomerBalanceArgs
            {
                BankTransfer = new Stripe.Inputs.SubscriptionPaymentSettingsPaymentMethodOptionsCustomerBalanceBankTransferArgs
                {
                    EuBankTransfer = new Stripe.Inputs.SubscriptionPaymentSettingsPaymentMethodOptionsCustomerBalanceBankTransferEuBankTransferArgs
                    {
                        Country = "string",
                    },
                    Type = "string",
                },
                FundingType = "string",
            },
            Payto = new Stripe.Inputs.SubscriptionPaymentSettingsPaymentMethodOptionsPaytoArgs
            {
                MandateOptions = new Stripe.Inputs.SubscriptionPaymentSettingsPaymentMethodOptionsPaytoMandateOptionsArgs
                {
                    Amount = 0.0,
                    AmountType = "string",
                    Purpose = "string",
                },
            },
            Pix = new Stripe.Inputs.SubscriptionPaymentSettingsPaymentMethodOptionsPixArgs
            {
                ExpiresAfterSeconds = 0.0,
                MandateOptions = new Stripe.Inputs.SubscriptionPaymentSettingsPaymentMethodOptionsPixMandateOptionsArgs
                {
                    Amount = 0.0,
                    AmountIncludesIof = "string",
                    EndDate = "string",
                    PaymentSchedule = "string",
                },
            },
            Upi = new Stripe.Inputs.SubscriptionPaymentSettingsPaymentMethodOptionsUpiArgs
            {
                MandateOptions = new Stripe.Inputs.SubscriptionPaymentSettingsPaymentMethodOptionsUpiMandateOptionsArgs
                {
                    Amount = 0.0,
                    AmountType = "string",
                    Description = "string",
                    EndDate = 0.0,
                },
            },
            UsBankAccount = new Stripe.Inputs.SubscriptionPaymentSettingsPaymentMethodOptionsUsBankAccountArgs
            {
                FinancialConnections = new Stripe.Inputs.SubscriptionPaymentSettingsPaymentMethodOptionsUsBankAccountFinancialConnectionsArgs
                {
                    Filters = new Stripe.Inputs.SubscriptionPaymentSettingsPaymentMethodOptionsUsBankAccountFinancialConnectionsFiltersArgs
                    {
                        AccountSubcategories = new[]
                        {
                            "string",
                        },
                    },
                    Permissions = new[]
                    {
                        "string",
                    },
                    Prefetches = new[]
                    {
                        "string",
                    },
                },
                VerificationMethod = "string",
            },
        },
        PaymentMethodTypes = new[]
        {
            "string",
        },
        SaveDefaultPaymentMethod = "string",
    },
    PendingInvoiceItemInterval = new Stripe.Inputs.SubscriptionPendingInvoiceItemIntervalArgs
    {
        Interval = "string",
        IntervalCount = 0.0,
    },
    ProrationBehavior = "string",
    TransferData = new Stripe.Inputs.SubscriptionTransferDataArgs
    {
        Destination = "string",
        AmountPercent = 0.0,
    },
    TrialEnd = 0.0,
    TrialFromPlan = false,
    TrialPeriodDays = 0.0,
    TrialSettings = new Stripe.Inputs.SubscriptionTrialSettingsArgs
    {
        EndBehavior = new Stripe.Inputs.SubscriptionTrialSettingsEndBehaviorArgs
        {
            MissingPaymentMethod = "string",
        },
    },
});

    example, err := stripe.NewSubscription(ctx, "subscriptionResource", &stripe.SubscriptionArgs{
	AddInvoiceItems: stripe.SubscriptionAddInvoiceItemArray{
		&stripe.SubscriptionAddInvoiceItemArgs{
			Discountable: pulumi.Bool(false),
			Discounts: stripe.SubscriptionAddInvoiceItemDiscountArray{
				&stripe.SubscriptionAddInvoiceItemDiscountArgs{
					Coupon:        pulumi.String("string"),
					Discount:      pulumi.String("string"),
					PromotionCode: pulumi.String("string"),
				},
			},
			Metadata: pulumi.StringMap{
				"string": pulumi.String("string"),
			},
			Period: &stripe.SubscriptionAddInvoiceItemPeriodArgs{
				End: &stripe.SubscriptionAddInvoiceItemPeriodEndArgs{
					Type:      pulumi.String("string"),
					Timestamp: pulumi.Float64(0),
				},
				Start: &stripe.SubscriptionAddInvoiceItemPeriodStartArgs{
					Type:      pulumi.String("string"),
					Timestamp: pulumi.Float64(0),
				},
			},
			Price: pulumi.String("string"),
			PriceData: &stripe.SubscriptionAddInvoiceItemPriceDataArgs{
				Currency:          pulumi.String("string"),
				Product:           pulumi.String("string"),
				TaxBehavior:       pulumi.String("string"),
				UnitAmount:        pulumi.Float64(0),
				UnitAmountDecimal: pulumi.Float64(0),
			},
			Quantity: pulumi.Float64(0),
			TaxRates: pulumi.StringArray{
				pulumi.String("string"),
			},
		},
	},
	ApplicationFeePercent: pulumi.Float64(0),
	AutomaticTax: &stripe.SubscriptionAutomaticTaxArgs{
		Enabled:        pulumi.Bool(false),
		DisabledReason: pulumi.String("string"),
		Liability: &stripe.SubscriptionAutomaticTaxLiabilityArgs{
			Type:    pulumi.String("string"),
			Account: pulumi.String("string"),
		},
	},
	BackdateStartDate:  pulumi.Float64(0),
	BillingCycleAnchor: pulumi.Float64(0),
	BillingCycleAnchorConfig: &stripe.SubscriptionBillingCycleAnchorConfigArgs{
		DayOfMonth: pulumi.Float64(0),
		Hour:       pulumi.Float64(0),
		Minute:     pulumi.Float64(0),
		Month:      pulumi.Float64(0),
		Second:     pulumi.Float64(0),
	},
	BillingMode: &stripe.SubscriptionBillingModeArgs{
		Type: pulumi.String("string"),
		Flexible: &stripe.SubscriptionBillingModeFlexibleArgs{
			ProrationDiscounts: pulumi.String("string"),
		},
		UpdatedAt: pulumi.Float64(0),
	},
	BillingSchedules: stripe.SubscriptionBillingScheduleArray{
		&stripe.SubscriptionBillingScheduleArgs{
			BillUntil: &stripe.SubscriptionBillingScheduleBillUntilArgs{
				Type:              pulumi.String("string"),
				ComputedTimestamp: pulumi.Float64(0),
				Duration: &stripe.SubscriptionBillingScheduleBillUntilDurationArgs{
					Interval:      pulumi.String("string"),
					IntervalCount: pulumi.Float64(0),
				},
				Timestamp: pulumi.Float64(0),
			},
			AppliesTos: stripe.SubscriptionBillingScheduleAppliesToArray{
				&stripe.SubscriptionBillingScheduleAppliesToArgs{
					Type:  pulumi.String("string"),
					Price: pulumi.String("string"),
				},
			},
			Key: pulumi.String("string"),
		},
	},
	BillingThresholds: &stripe.SubscriptionBillingThresholdsArgs{
		AmountGte:               pulumi.Float64(0),
		ResetBillingCycleAnchor: pulumi.Bool(false),
	},
	CancelAt:          pulumi.Float64(0),
	CancelAtPeriodEnd: pulumi.Bool(false),
	CancellationDetails: &stripe.SubscriptionCancellationDetailsArgs{
		Comment:  pulumi.String("string"),
		Feedback: pulumi.String("string"),
		Reason:   pulumi.String("string"),
	},
	CollectionMethod:     pulumi.String("string"),
	Currency:             pulumi.String("string"),
	Customer:             pulumi.String("string"),
	CustomerAccount:      pulumi.String("string"),
	DaysUntilDue:         pulumi.Float64(0),
	DefaultPaymentMethod: pulumi.String("string"),
	DefaultSource:        pulumi.String("string"),
	DefaultTaxRates: pulumi.StringArray{
		pulumi.String("string"),
	},
	Description: pulumi.String("string"),
	Discounts: stripe.SubscriptionDiscountArray{
		&stripe.SubscriptionDiscountArgs{
			Coupon:        pulumi.String("string"),
			Discount:      pulumi.String("string"),
			PromotionCode: pulumi.String("string"),
		},
	},
	InvoiceSettings: &stripe.SubscriptionInvoiceSettingsArgs{
		AccountTaxIds: pulumi.StringArray{
			pulumi.String("string"),
		},
		Issuer: &stripe.SubscriptionInvoiceSettingsIssuerArgs{
			Type:    pulumi.String("string"),
			Account: pulumi.String("string"),
		},
	},
	Items: stripe.SubscriptionItemTypeArray{
		&stripe.SubscriptionItemTypeArgs{
			BillingThresholds: &stripe.SubscriptionItemBillingThresholdsArgs{
				UsageGte: pulumi.Float64(0),
			},
			Discounts: stripe.SubscriptionItemDiscountArray{
				&stripe.SubscriptionItemDiscountArgs{
					Coupon:        pulumi.String("string"),
					Discount:      pulumi.String("string"),
					PromotionCode: pulumi.String("string"),
				},
			},
			Id: pulumi.String("string"),
			Metadata: pulumi.StringMap{
				"string": pulumi.String("string"),
			},
			Price: pulumi.String("string"),
			PriceData: &stripe.SubscriptionItemPriceDataArgs{
				Currency: pulumi.String("string"),
				Product:  pulumi.String("string"),
				Recurring: &stripe.SubscriptionItemPriceDataRecurringArgs{
					Interval:      pulumi.String("string"),
					IntervalCount: pulumi.Float64(0),
				},
				TaxBehavior:       pulumi.String("string"),
				UnitAmount:        pulumi.Float64(0),
				UnitAmountDecimal: pulumi.Float64(0),
			},
			Quantity: pulumi.Float64(0),
			TaxRates: pulumi.StringArray{
				pulumi.String("string"),
			},
		},
	},
	Metadata: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	OffSession: pulumi.Bool(false),
	OnBehalfOf: pulumi.String("string"),
	PauseCollection: &stripe.SubscriptionPauseCollectionArgs{
		Behavior:  pulumi.String("string"),
		ResumesAt: pulumi.Float64(0),
	},
	PaymentBehavior: pulumi.String("string"),
	PaymentSettings: &stripe.SubscriptionPaymentSettingsArgs{
		PaymentMethodOptions: &stripe.SubscriptionPaymentSettingsPaymentMethodOptionsArgs{
			AcssDebit: &stripe.SubscriptionPaymentSettingsPaymentMethodOptionsAcssDebitArgs{
				MandateOptions: &stripe.SubscriptionPaymentSettingsPaymentMethodOptionsAcssDebitMandateOptionsArgs{
					TransactionType: pulumi.String("string"),
				},
				VerificationMethod: pulumi.String("string"),
			},
			Bancontact: &stripe.SubscriptionPaymentSettingsPaymentMethodOptionsBancontactArgs{
				PreferredLanguage: pulumi.String("string"),
			},
			Card: &stripe.SubscriptionPaymentSettingsPaymentMethodOptionsCardArgs{
				MandateOptions: &stripe.SubscriptionPaymentSettingsPaymentMethodOptionsCardMandateOptionsArgs{
					Amount:      pulumi.Float64(0),
					AmountType:  pulumi.String("string"),
					Description: pulumi.String("string"),
				},
				Network:             pulumi.String("string"),
				RequestThreeDSecure: pulumi.String("string"),
			},
			CustomerBalance: &stripe.SubscriptionPaymentSettingsPaymentMethodOptionsCustomerBalanceArgs{
				BankTransfer: &stripe.SubscriptionPaymentSettingsPaymentMethodOptionsCustomerBalanceBankTransferArgs{
					EuBankTransfer: &stripe.SubscriptionPaymentSettingsPaymentMethodOptionsCustomerBalanceBankTransferEuBankTransferArgs{
						Country: pulumi.String("string"),
					},
					Type: pulumi.String("string"),
				},
				FundingType: pulumi.String("string"),
			},
			Payto: &stripe.SubscriptionPaymentSettingsPaymentMethodOptionsPaytoArgs{
				MandateOptions: &stripe.SubscriptionPaymentSettingsPaymentMethodOptionsPaytoMandateOptionsArgs{
					Amount:     pulumi.Float64(0),
					AmountType: pulumi.String("string"),
					Purpose:    pulumi.String("string"),
				},
			},
			Pix: &stripe.SubscriptionPaymentSettingsPaymentMethodOptionsPixArgs{
				ExpiresAfterSeconds: pulumi.Float64(0),
				MandateOptions: &stripe.SubscriptionPaymentSettingsPaymentMethodOptionsPixMandateOptionsArgs{
					Amount:            pulumi.Float64(0),
					AmountIncludesIof: pulumi.String("string"),
					EndDate:           pulumi.String("string"),
					PaymentSchedule:   pulumi.String("string"),
				},
			},
			Upi: &stripe.SubscriptionPaymentSettingsPaymentMethodOptionsUpiArgs{
				MandateOptions: &stripe.SubscriptionPaymentSettingsPaymentMethodOptionsUpiMandateOptionsArgs{
					Amount:      pulumi.Float64(0),
					AmountType:  pulumi.String("string"),
					Description: pulumi.String("string"),
					EndDate:     pulumi.Float64(0),
				},
			},
			UsBankAccount: &stripe.SubscriptionPaymentSettingsPaymentMethodOptionsUsBankAccountArgs{
				FinancialConnections: &stripe.SubscriptionPaymentSettingsPaymentMethodOptionsUsBankAccountFinancialConnectionsArgs{
					Filters: &stripe.SubscriptionPaymentSettingsPaymentMethodOptionsUsBankAccountFinancialConnectionsFiltersArgs{
						AccountSubcategories: pulumi.StringArray{
							pulumi.String("string"),
						},
					},
					Permissions: pulumi.StringArray{
						pulumi.String("string"),
					},
					Prefetches: pulumi.StringArray{
						pulumi.String("string"),
					},
				},
				VerificationMethod: pulumi.String("string"),
			},
		},
		PaymentMethodTypes: pulumi.StringArray{
			pulumi.String("string"),
		},
		SaveDefaultPaymentMethod: pulumi.String("string"),
	},
	PendingInvoiceItemInterval: &stripe.SubscriptionPendingInvoiceItemIntervalArgs{
		Interval:      pulumi.String("string"),
		IntervalCount: pulumi.Float64(0),
	},
	ProrationBehavior: pulumi.String("string"),
	TransferData: &stripe.SubscriptionTransferDataArgs{
		Destination:   pulumi.String("string"),
		AmountPercent: pulumi.Float64(0),
	},
	TrialEnd:        pulumi.Float64(0),
	TrialFromPlan:   pulumi.Bool(false),
	TrialPeriodDays: pulumi.Float64(0),
	TrialSettings: &stripe.SubscriptionTrialSettingsArgs{
		EndBehavior: &stripe.SubscriptionTrialSettingsEndBehaviorArgs{
			MissingPaymentMethod: pulumi.String("string"),
		},
	},
})

    resource "stripe_subscription" "subscriptionResource" {
  lifecycle {
    create_before_destroy = true
  }
  add_invoice_items {
    discountable = false
    discounts {
      coupon         = "string"
      discount       = "string"
      promotion_code = "string"
    }
    metadata = {
      "string" = "string"
    }
    period = {
      end = {
        type      = "string"
        timestamp = 0
      }
      start = {
        type      = "string"
        timestamp = 0
      }
    }
    price = "string"
    price_data = {
      currency            = "string"
      product             = "string"
      tax_behavior        = "string"
      unit_amount         = 0
      unit_amount_decimal = 0
    }
    quantity  = 0
    tax_rates = ["string"]
  }
  application_fee_percent = 0
  automatic_tax = {
    enabled         = false
    disabled_reason = "string"
    liability = {
      type    = "string"
      account = "string"
    }
  }
  backdate_start_date  = 0
  billing_cycle_anchor = 0
  billing_cycle_anchor_config = {
    day_of_month = 0
    hour         = 0
    minute       = 0
    month        = 0
    second       = 0
  }
  billing_mode = {
    type = "string"
    flexible = {
      proration_discounts = "string"
    }
    updated_at = 0
  }
  billing_schedules {
    bill_until = {
      type               = "string"
      computed_timestamp = 0
      duration = {
        interval       = "string"
        interval_count = 0
      }
      timestamp = 0
    }
    applies_tos {
      type  = "string"
      price = "string"
    }
    key = "string"
  }
  billing_thresholds = {
    amount_gte                 = 0
    reset_billing_cycle_anchor = false
  }
  cancel_at            = 0
  cancel_at_period_end = false
  cancellation_details = {
    comment  = "string"
    feedback = "string"
    reason   = "string"
  }
  collection_method      = "string"
  currency               = "string"
  customer               = "string"
  customer_account       = "string"
  days_until_due         = 0
  default_payment_method = "string"
  default_source         = "string"
  default_tax_rates      = ["string"]
  description            = "string"
  discounts {
    coupon         = "string"
    discount       = "string"
    promotion_code = "string"
  }
  invoice_settings = {
    account_tax_ids = ["string"]
    issuer = {
      type    = "string"
      account = "string"
    }
  }
  items {
    billing_thresholds = {
      usage_gte = 0
    }
    discounts {
      coupon         = "string"
      discount       = "string"
      promotion_code = "string"
    }
    id = "string"
    metadata = {
      "string" = "string"
    }
    price = "string"
    price_data = {
      currency = "string"
      product  = "string"
      recurring = {
        interval       = "string"
        interval_count = 0
      }
      tax_behavior        = "string"
      unit_amount         = 0
      unit_amount_decimal = 0
    }
    quantity  = 0
    tax_rates = ["string"]
  }
  metadata = {
    "string" = "string"
  }
  off_session  = false
  on_behalf_of = "string"
  pause_collection = {
    behavior   = "string"
    resumes_at = 0
  }
  payment_behavior = "string"
  payment_settings = {
    payment_method_options = {
      acss_debit = {
        mandate_options = {
          transaction_type = "string"
        }
        verification_method = "string"
      }
      bancontact = {
        preferred_language = "string"
      }
      card = {
        mandate_options = {
          amount      = 0
          amount_type = "string"
          description = "string"
        }
        network                = "string"
        request_three_d_secure = "string"
      }
      customer_balance = {
        bank_transfer = {
          eu_bank_transfer = {
            country = "string"
          }
          type = "string"
        }
        funding_type = "string"
      }
      payto = {
        mandate_options = {
          amount      = 0
          amount_type = "string"
          purpose     = "string"
        }
      }
      pix = {
        expires_after_seconds = 0
        mandate_options = {
          amount              = 0
          amount_includes_iof = "string"
          end_date            = "string"
          payment_schedule    = "string"
        }
      }
      upi = {
        mandate_options = {
          amount      = 0
          amount_type = "string"
          description = "string"
          end_date    = 0
        }
      }
      us_bank_account = {
        financial_connections = {
          filters = {
            account_subcategories = ["string"]
          }
          permissions = ["string"]
          prefetches  = ["string"]
        }
        verification_method = "string"
      }
    }
    payment_method_types        = ["string"]
    save_default_payment_method = "string"
  }
  pending_invoice_item_interval = {
    interval       = "string"
    interval_count = 0
  }
  proration_behavior = "string"
  transfer_data = {
    destination    = "string"
    amount_percent = 0
  }
  trial_end         = 0
  trial_from_plan   = false
  trial_period_days = 0
  trial_settings = {
    end_behavior = {
      missing_payment_method = "string"
    }
  }
}

    var subscriptionResource = new Subscription("subscriptionResource", SubscriptionArgs.builder()
    .addInvoiceItems(SubscriptionAddInvoiceItemArgs.builder()
        .discountable(false)
        .discounts(SubscriptionAddInvoiceItemDiscountArgs.builder()
            .coupon("string")
            .discount("string")
            .promotionCode("string")
            .build())
        .metadata(Map.of("string", "string"))
        .period(SubscriptionAddInvoiceItemPeriodArgs.builder()
            .end(SubscriptionAddInvoiceItemPeriodEndArgs.builder()
                .type("string")
                .timestamp(0.0)
                .build())
            .start(SubscriptionAddInvoiceItemPeriodStartArgs.builder()
                .type("string")
                .timestamp(0.0)
                .build())
            .build())
        .price("string")
        .priceData(SubscriptionAddInvoiceItemPriceDataArgs.builder()
            .currency("string")
            .product("string")
            .taxBehavior("string")
            .unitAmount(0.0)
            .unitAmountDecimal(0.0)
            .build())
        .quantity(0.0)
        .taxRates("string")
        .build())
    .applicationFeePercent(0.0)
    .automaticTax(SubscriptionAutomaticTaxArgs.builder()
        .enabled(false)
        .disabledReason("string")
        .liability(SubscriptionAutomaticTaxLiabilityArgs.builder()
            .type("string")
            .account("string")
            .build())
        .build())
    .backdateStartDate(0.0)
    .billingCycleAnchor(0.0)
    .billingCycleAnchorConfig(SubscriptionBillingCycleAnchorConfigArgs.builder()
        .dayOfMonth(0.0)
        .hour(0.0)
        .minute(0.0)
        .month(0.0)
        .second(0.0)
        .build())
    .billingMode(SubscriptionBillingModeArgs.builder()
        .type("string")
        .flexible(SubscriptionBillingModeFlexibleArgs.builder()
            .prorationDiscounts("string")
            .build())
        .updatedAt(0.0)
        .build())
    .billingSchedules(SubscriptionBillingScheduleArgs.builder()
        .billUntil(SubscriptionBillingScheduleBillUntilArgs.builder()
            .type("string")
            .computedTimestamp(0.0)
            .duration(SubscriptionBillingScheduleBillUntilDurationArgs.builder()
                .interval("string")
                .intervalCount(0.0)
                .build())
            .timestamp(0.0)
            .build())
        .appliesTos(SubscriptionBillingScheduleAppliesToArgs.builder()
            .type("string")
            .price("string")
            .build())
        .key("string")
        .build())
    .billingThresholds(SubscriptionBillingThresholdsArgs.builder()
        .amountGte(0.0)
        .resetBillingCycleAnchor(false)
        .build())
    .cancelAt(0.0)
    .cancelAtPeriodEnd(false)
    .cancellationDetails(SubscriptionCancellationDetailsArgs.builder()
        .comment("string")
        .feedback("string")
        .reason("string")
        .build())
    .collectionMethod("string")
    .currency("string")
    .customer("string")
    .customerAccount("string")
    .daysUntilDue(0.0)
    .defaultPaymentMethod("string")
    .defaultSource("string")
    .defaultTaxRates("string")
    .description("string")
    .discounts(SubscriptionDiscountArgs.builder()
        .coupon("string")
        .discount("string")
        .promotionCode("string")
        .build())
    .invoiceSettings(SubscriptionInvoiceSettingsArgs.builder()
        .accountTaxIds("string")
        .issuer(SubscriptionInvoiceSettingsIssuerArgs.builder()
            .type("string")
            .account("string")
            .build())
        .build())
    .items(com.pulumi.stripe.inputs.SubscriptionItemArgs.builder()
        .billingThresholds(SubscriptionItemBillingThresholdsArgs.builder()
            .usageGte(0.0)
            .build())
        .discounts(SubscriptionItemDiscountArgs.builder()
            .coupon("string")
            .discount("string")
            .promotionCode("string")
            .build())
        .id("string")
        .metadata(Map.of("string", "string"))
        .price("string")
        .priceData(SubscriptionItemPriceDataArgs.builder()
            .currency("string")
            .product("string")
            .recurring(SubscriptionItemPriceDataRecurringArgs.builder()
                .interval("string")
                .intervalCount(0.0)
                .build())
            .taxBehavior("string")
            .unitAmount(0.0)
            .unitAmountDecimal(0.0)
            .build())
        .quantity(0.0)
        .taxRates("string")
        .build())
    .metadata(Map.of("string", "string"))
    .offSession(false)
    .onBehalfOf("string")
    .pauseCollection(SubscriptionPauseCollectionArgs.builder()
        .behavior("string")
        .resumesAt(0.0)
        .build())
    .paymentBehavior("string")
    .paymentSettings(SubscriptionPaymentSettingsArgs.builder()
        .paymentMethodOptions(SubscriptionPaymentSettingsPaymentMethodOptionsArgs.builder()
            .acssDebit(SubscriptionPaymentSettingsPaymentMethodOptionsAcssDebitArgs.builder()
                .mandateOptions(SubscriptionPaymentSettingsPaymentMethodOptionsAcssDebitMandateOptionsArgs.builder()
                    .transactionType("string")
                    .build())
                .verificationMethod("string")
                .build())
            .bancontact(SubscriptionPaymentSettingsPaymentMethodOptionsBancontactArgs.builder()
                .preferredLanguage("string")
                .build())
            .card(SubscriptionPaymentSettingsPaymentMethodOptionsCardArgs.builder()
                .mandateOptions(SubscriptionPaymentSettingsPaymentMethodOptionsCardMandateOptionsArgs.builder()
                    .amount(0.0)
                    .amountType("string")
                    .description("string")
                    .build())
                .network("string")
                .requestThreeDSecure("string")
                .build())
            .customerBalance(SubscriptionPaymentSettingsPaymentMethodOptionsCustomerBalanceArgs.builder()
                .bankTransfer(SubscriptionPaymentSettingsPaymentMethodOptionsCustomerBalanceBankTransferArgs.builder()
                    .euBankTransfer(SubscriptionPaymentSettingsPaymentMethodOptionsCustomerBalanceBankTransferEuBankTransferArgs.builder()
                        .country("string")
                        .build())
                    .type("string")
                    .build())
                .fundingType("string")
                .build())
            .payto(SubscriptionPaymentSettingsPaymentMethodOptionsPaytoArgs.builder()
                .mandateOptions(SubscriptionPaymentSettingsPaymentMethodOptionsPaytoMandateOptionsArgs.builder()
                    .amount(0.0)
                    .amountType("string")
                    .purpose("string")
                    .build())
                .build())
            .pix(SubscriptionPaymentSettingsPaymentMethodOptionsPixArgs.builder()
                .expiresAfterSeconds(0.0)
                .mandateOptions(SubscriptionPaymentSettingsPaymentMethodOptionsPixMandateOptionsArgs.builder()
                    .amount(0.0)
                    .amountIncludesIof("string")
                    .endDate("string")
                    .paymentSchedule("string")
                    .build())
                .build())
            .upi(SubscriptionPaymentSettingsPaymentMethodOptionsUpiArgs.builder()
                .mandateOptions(SubscriptionPaymentSettingsPaymentMethodOptionsUpiMandateOptionsArgs.builder()
                    .amount(0.0)
                    .amountType("string")
                    .description("string")
                    .endDate(0.0)
                    .build())
                .build())
            .usBankAccount(SubscriptionPaymentSettingsPaymentMethodOptionsUsBankAccountArgs.builder()
                .financialConnections(SubscriptionPaymentSettingsPaymentMethodOptionsUsBankAccountFinancialConnectionsArgs.builder()
                    .filters(SubscriptionPaymentSettingsPaymentMethodOptionsUsBankAccountFinancialConnectionsFiltersArgs.builder()
                        .accountSubcategories("string")
                        .build())
                    .permissions("string")
                    .prefetches("string")
                    .build())
                .verificationMethod("string")
                .build())
            .build())
        .paymentMethodTypes("string")
        .saveDefaultPaymentMethod("string")
        .build())
    .pendingInvoiceItemInterval(SubscriptionPendingInvoiceItemIntervalArgs.builder()
        .interval("string")
        .intervalCount(0.0)
        .build())
    .prorationBehavior("string")
    .transferData(SubscriptionTransferDataArgs.builder()
        .destination("string")
        .amountPercent(0.0)
        .build())
    .trialEnd(0.0)
    .trialFromPlan(false)
    .trialPeriodDays(0.0)
    .trialSettings(SubscriptionTrialSettingsArgs.builder()
        .endBehavior(SubscriptionTrialSettingsEndBehaviorArgs.builder()
            .missingPaymentMethod("string")
            .build())
        .build())
    .build());

    subscription_resource = stripe.Subscription("subscriptionResource",
    add_invoice_items=[{
        "discountable": False,
        "discounts": [{
            "coupon": "string",
            "discount": "string",
            "promotion_code": "string",
        }],
        "metadata": {
            "string": "string",
        },
        "period": {
            "end": {
                "type": "string",
                "timestamp": float(0),
            },
            "start": {
                "type": "string",
                "timestamp": float(0),
            },
        },
        "price": "string",
        "price_data": {
            "currency": "string",
            "product": "string",
            "tax_behavior": "string",
            "unit_amount": float(0),
            "unit_amount_decimal": float(0),
        },
        "quantity": float(0),
        "tax_rates": ["string"],
    }],
    application_fee_percent=float(0),
    automatic_tax={
        "enabled": False,
        "disabled_reason": "string",
        "liability": {
            "type": "string",
            "account": "string",
        },
    },
    backdate_start_date=float(0),
    billing_cycle_anchor=float(0),
    billing_cycle_anchor_config={
        "day_of_month": float(0),
        "hour": float(0),
        "minute": float(0),
        "month": float(0),
        "second": float(0),
    },
    billing_mode={
        "type": "string",
        "flexible": {
            "proration_discounts": "string",
        },
        "updated_at": float(0),
    },
    billing_schedules=[{
        "bill_until": {
            "type": "string",
            "computed_timestamp": float(0),
            "duration": {
                "interval": "string",
                "interval_count": float(0),
            },
            "timestamp": float(0),
        },
        "applies_tos": [{
            "type": "string",
            "price": "string",
        }],
        "key": "string",
    }],
    billing_thresholds={
        "amount_gte": float(0),
        "reset_billing_cycle_anchor": False,
    },
    cancel_at=float(0),
    cancel_at_period_end=False,
    cancellation_details={
        "comment": "string",
        "feedback": "string",
        "reason": "string",
    },
    collection_method="string",
    currency="string",
    customer="string",
    customer_account="string",
    days_until_due=float(0),
    default_payment_method="string",
    default_source="string",
    default_tax_rates=["string"],
    description="string",
    discounts=[{
        "coupon": "string",
        "discount": "string",
        "promotion_code": "string",
    }],
    invoice_settings={
        "account_tax_ids": ["string"],
        "issuer": {
            "type": "string",
            "account": "string",
        },
    },
    items=[{
        "billing_thresholds": {
            "usage_gte": float(0),
        },
        "discounts": [{
            "coupon": "string",
            "discount": "string",
            "promotion_code": "string",
        }],
        "id": "string",
        "metadata": {
            "string": "string",
        },
        "price": "string",
        "price_data": {
            "currency": "string",
            "product": "string",
            "recurring": {
                "interval": "string",
                "interval_count": float(0),
            },
            "tax_behavior": "string",
            "unit_amount": float(0),
            "unit_amount_decimal": float(0),
        },
        "quantity": float(0),
        "tax_rates": ["string"],
    }],
    metadata={
        "string": "string",
    },
    off_session=False,
    on_behalf_of="string",
    pause_collection={
        "behavior": "string",
        "resumes_at": float(0),
    },
    payment_behavior="string",
    payment_settings={
        "payment_method_options": {
            "acss_debit": {
                "mandate_options": {
                    "transaction_type": "string",
                },
                "verification_method": "string",
            },
            "bancontact": {
                "preferred_language": "string",
            },
            "card": {
                "mandate_options": {
                    "amount": float(0),
                    "amount_type": "string",
                    "description": "string",
                },
                "network": "string",
                "request_three_d_secure": "string",
            },
            "customer_balance": {
                "bank_transfer": {
                    "eu_bank_transfer": {
                        "country": "string",
                    },
                    "type": "string",
                },
                "funding_type": "string",
            },
            "payto": {
                "mandate_options": {
                    "amount": float(0),
                    "amount_type": "string",
                    "purpose": "string",
                },
            },
            "pix": {
                "expires_after_seconds": float(0),
                "mandate_options": {
                    "amount": float(0),
                    "amount_includes_iof": "string",
                    "end_date": "string",
                    "payment_schedule": "string",
                },
            },
            "upi": {
                "mandate_options": {
                    "amount": float(0),
                    "amount_type": "string",
                    "description": "string",
                    "end_date": float(0),
                },
            },
            "us_bank_account": {
                "financial_connections": {
                    "filters": {
                        "account_subcategories": ["string"],
                    },
                    "permissions": ["string"],
                    "prefetches": ["string"],
                },
                "verification_method": "string",
            },
        },
        "payment_method_types": ["string"],
        "save_default_payment_method": "string",
    },
    pending_invoice_item_interval={
        "interval": "string",
        "interval_count": float(0),
    },
    proration_behavior="string",
    transfer_data={
        "destination": "string",
        "amount_percent": float(0),
    },
    trial_end=float(0),
    trial_from_plan=False,
    trial_period_days=float(0),
    trial_settings={
        "end_behavior": {
            "missing_payment_method": "string",
        },
    })

    const subscriptionResource = new stripe.Subscription("subscriptionResource", {
    addInvoiceItems: [{
        discountable: false,
        discounts: [{
            coupon: "string",
            discount: "string",
            promotionCode: "string",
        }],
        metadata: {
            string: "string",
        },
        period: {
            end: {
                type: "string",
                timestamp: 0,
            },
            start: {
                type: "string",
                timestamp: 0,
            },
        },
        price: "string",
        priceData: {
            currency: "string",
            product: "string",
            taxBehavior: "string",
            unitAmount: 0,
            unitAmountDecimal: 0,
        },
        quantity: 0,
        taxRates: ["string"],
    }],
    applicationFeePercent: 0,
    automaticTax: {
        enabled: false,
        disabledReason: "string",
        liability: {
            type: "string",
            account: "string",
        },
    },
    backdateStartDate: 0,
    billingCycleAnchor: 0,
    billingCycleAnchorConfig: {
        dayOfMonth: 0,
        hour: 0,
        minute: 0,
        month: 0,
        second: 0,
    },
    billingMode: {
        type: "string",
        flexible: {
            prorationDiscounts: "string",
        },
        updatedAt: 0,
    },
    billingSchedules: [{
        billUntil: {
            type: "string",
            computedTimestamp: 0,
            duration: {
                interval: "string",
                intervalCount: 0,
            },
            timestamp: 0,
        },
        appliesTos: [{
            type: "string",
            price: "string",
        }],
        key: "string",
    }],
    billingThresholds: {
        amountGte: 0,
        resetBillingCycleAnchor: false,
    },
    cancelAt: 0,
    cancelAtPeriodEnd: false,
    cancellationDetails: {
        comment: "string",
        feedback: "string",
        reason: "string",
    },
    collectionMethod: "string",
    currency: "string",
    customer: "string",
    customerAccount: "string",
    daysUntilDue: 0,
    defaultPaymentMethod: "string",
    defaultSource: "string",
    defaultTaxRates: ["string"],
    description: "string",
    discounts: [{
        coupon: "string",
        discount: "string",
        promotionCode: "string",
    }],
    invoiceSettings: {
        accountTaxIds: ["string"],
        issuer: {
            type: "string",
            account: "string",
        },
    },
    items: [{
        billingThresholds: {
            usageGte: 0,
        },
        discounts: [{
            coupon: "string",
            discount: "string",
            promotionCode: "string",
        }],
        id: "string",
        metadata: {
            string: "string",
        },
        price: "string",
        priceData: {
            currency: "string",
            product: "string",
            recurring: {
                interval: "string",
                intervalCount: 0,
            },
            taxBehavior: "string",
            unitAmount: 0,
            unitAmountDecimal: 0,
        },
        quantity: 0,
        taxRates: ["string"],
    }],
    metadata: {
        string: "string",
    },
    offSession: false,
    onBehalfOf: "string",
    pauseCollection: {
        behavior: "string",
        resumesAt: 0,
    },
    paymentBehavior: "string",
    paymentSettings: {
        paymentMethodOptions: {
            acssDebit: {
                mandateOptions: {
                    transactionType: "string",
                },
                verificationMethod: "string",
            },
            bancontact: {
                preferredLanguage: "string",
            },
            card: {
                mandateOptions: {
                    amount: 0,
                    amountType: "string",
                    description: "string",
                },
                network: "string",
                requestThreeDSecure: "string",
            },
            customerBalance: {
                bankTransfer: {
                    euBankTransfer: {
                        country: "string",
                    },
                    type: "string",
                },
                fundingType: "string",
            },
            payto: {
                mandateOptions: {
                    amount: 0,
                    amountType: "string",
                    purpose: "string",
                },
            },
            pix: {
                expiresAfterSeconds: 0,
                mandateOptions: {
                    amount: 0,
                    amountIncludesIof: "string",
                    endDate: "string",
                    paymentSchedule: "string",
                },
            },
            upi: {
                mandateOptions: {
                    amount: 0,
                    amountType: "string",
                    description: "string",
                    endDate: 0,
                },
            },
            usBankAccount: {
                financialConnections: {
                    filters: {
                        accountSubcategories: ["string"],
                    },
                    permissions: ["string"],
                    prefetches: ["string"],
                },
                verificationMethod: "string",
            },
        },
        paymentMethodTypes: ["string"],
        saveDefaultPaymentMethod: "string",
    },
    pendingInvoiceItemInterval: {
        interval: "string",
        intervalCount: 0,
    },
    prorationBehavior: "string",
    transferData: {
        destination: "string",
        amountPercent: 0,
    },
    trialEnd: 0,
    trialFromPlan: false,
    trialPeriodDays: 0,
    trialSettings: {
        endBehavior: {
            missingPaymentMethod: "string",
        },
    },
});

    type: stripe:Subscription
properties:
    addInvoiceItems:
        - discountable: false
          discounts:
            - coupon: string
              discount: string
              promotionCode: string
          metadata:
            string: string
          period:
            end:
                timestamp: 0
                type: string
            start:
                timestamp: 0
                type: string
          price: string
          priceData:
            currency: string
            product: string
            taxBehavior: string
            unitAmount: 0
            unitAmountDecimal: 0
          quantity: 0
          taxRates:
            - string
    applicationFeePercent: 0
    automaticTax:
        disabledReason: string
        enabled: false
        liability:
            account: string
            type: string
    backdateStartDate: 0
    billingCycleAnchor: 0
    billingCycleAnchorConfig:
        dayOfMonth: 0
        hour: 0
        minute: 0
        month: 0
        second: 0
    billingMode:
        flexible:
            prorationDiscounts: string
        type: string
        updatedAt: 0
    billingSchedules:
        - appliesTos:
            - price: string
              type: string
          billUntil:
            computedTimestamp: 0
            duration:
                interval: string
                intervalCount: 0
            timestamp: 0
            type: string
          key: string
    billingThresholds:
        amountGte: 0
        resetBillingCycleAnchor: false
    cancelAt: 0
    cancelAtPeriodEnd: false
    cancellationDetails:
        comment: string
        feedback: string
        reason: string
    collectionMethod: string
    currency: string
    customer: string
    customerAccount: string
    daysUntilDue: 0
    defaultPaymentMethod: string
    defaultSource: string
    defaultTaxRates:
        - string
    description: string
    discounts:
        - coupon: string
          discount: string
          promotionCode: string
    invoiceSettings:
        accountTaxIds:
            - string
        issuer:
            account: string
            type: string
    items:
        - billingThresholds:
            usageGte: 0
          discounts:
            - coupon: string
              discount: string
              promotionCode: string
          id: string
          metadata:
            string: string
          price: string
          priceData:
            currency: string
            product: string
            recurring:
                interval: string
                intervalCount: 0
            taxBehavior: string
            unitAmount: 0
            unitAmountDecimal: 0
          quantity: 0
          taxRates:
            - string
    metadata:
        string: string
    offSession: false
    onBehalfOf: string
    pauseCollection:
        behavior: string
        resumesAt: 0
    paymentBehavior: string
    paymentSettings:
        paymentMethodOptions:
            acssDebit:
                mandateOptions:
                    transactionType: string
                verificationMethod: string
            bancontact:
                preferredLanguage: string
            card:
                mandateOptions:
                    amount: 0
                    amountType: string
                    description: string
                network: string
                requestThreeDSecure: string
            customerBalance:
                bankTransfer:
                    euBankTransfer:
                        country: string
                    type: string
                fundingType: string
            payto:
                mandateOptions:
                    amount: 0
                    amountType: string
                    purpose: string
            pix:
                expiresAfterSeconds: 0
                mandateOptions:
                    amount: 0
                    amountIncludesIof: string
                    endDate: string
                    paymentSchedule: string
            upi:
                mandateOptions:
                    amount: 0
                    amountType: string
                    description: string
                    endDate: 0
            usBankAccount:
                financialConnections:
                    filters:
                        accountSubcategories:
                            - string
                    permissions:
                        - string
                    prefetches:
                        - string
                verificationMethod: string
        paymentMethodTypes:
            - string
        saveDefaultPaymentMethod: string
    pendingInvoiceItemInterval:
        interval: string
        intervalCount: 0
    prorationBehavior: string
    transferData:
        amountPercent: 0
        destination: string
    trialEnd: 0
    trialFromPlan: false
    trialPeriodDays: 0
    trialSettings:
        endBehavior:
            missingPaymentMethod: string

    Subscription Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Subscription resource accepts the following input properties:

    AddInvoiceItems List<SubscriptionAddInvoiceItem>
    A list of prices and quantities that will generate invoice items appended to the next invoice for this subscription. You may pass up to 20 items.
    ApplicationFeePercent double
    A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account.
    AutomaticTax SubscriptionAutomaticTax
    BackdateStartDate double
    A past timestamp to backdate the subscription's start date to. If set, the first invoice will contain line items for the timespan between the start date and the current time. Can be combined with trials and the billing cycle anchor.
    BillingCycleAnchor double
    The reference point that aligns future billing cycle dates. It sets the day of week for week intervals, the day of month for month and year intervals, and the month of year for year intervals. The timestamp is in UTC format.
    BillingCycleAnchorConfig SubscriptionBillingCycleAnchorConfig
    The fixed values used to calculate the billing_cycle_anchor.
    BillingMode SubscriptionBillingMode
    The billing mode of the subscription.
    BillingSchedules List<SubscriptionBillingSchedule>
    Billing schedules for this subscription.
    BillingThresholds SubscriptionBillingThresholds
    Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period
    CancelAt double
    A date in the future at which the subscription will automatically get canceled
    CancelAtPeriodEnd bool
    Whether this subscription will (if status=active) or did (if status=canceled) cancel at the end of the current billing period.
    CancellationDetails SubscriptionCancellationDetails
    Details about why this subscription was cancelled
    CollectionMethod string
    Either charge_automatically, or send_invoice. When charging automatically, Stripe will attempt to pay this subscription at the end of the cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as active.
    Currency string
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    Customer string
    ID of the customer who owns the subscription.
    CustomerAccount string
    ID of the account representing the customer who owns the subscription.
    DaysUntilDue double
    Number of days a customer has to pay invoices generated by this subscription. This value will be null for subscriptions where collection_method=charge_automatically.
    DefaultPaymentMethod string
    ID of the default payment method for the subscription. It must belong to the customer associated with the subscription. This takes precedence over default_source. If neither are set, invoices will use the customer's invoice_settings.default_payment_method or default_source.
    DefaultSource string
    ID of the default payment source for the subscription. It must belong to the customer associated with the subscription and be in a chargeable state. If default_payment_method is also set, default_payment_method will take precedence. If neither are set, invoices will use the customer's invoice_settings.default_payment_method or default_source.
    DefaultTaxRates List<string>
    The tax rates that will apply to any subscription item that does not have tax_rates set. Invoices created will have their default_tax_rates populated from the subscription.
    Description string
    The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.
    Discounts List<SubscriptionDiscount>
    The discounts applied to the subscription. Subscription item discounts are applied before subscription discounts. Use expand[]=discounts to expand each discount.
    InvoiceSettings SubscriptionInvoiceSettings
    Items List<SubscriptionItem>
    List of subscription items, each with an attached price.
    Metadata Dictionary<string, string>
    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
    OffSession bool
    Indicates if a customer is on or off-session while an invoice payment is attempted. Defaults to false (on-session).
    OnBehalfOf string
    The account (if any) the charge was made on behalf of for charges associated with this subscription. See the Connect documentation for details.
    PauseCollection SubscriptionPauseCollection
    If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to paused. Learn more about pausing collection.
    PaymentBehavior string
    Controls how Stripe handles the first invoice when payment is required and collection_method=charge_automatically. Subscriptions with collection_method=send_invoice are automatically activated regardless of the first Invoice status.
    PaymentSettings SubscriptionPaymentSettings
    Payment settings passed on to invoices created by the subscription.
    PendingInvoiceItemInterval SubscriptionPendingInvoiceItemInterval
    Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling Create an invoice for the given subscription at the specified interval.
    ProrationBehavior string
    Determines how to handle prorations resulting from the billing_cycle_anchor. If no value is passed, the default is create_prorations.
    TransferData SubscriptionTransferData
    The account (if any) the subscription's payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the subscription's invoices.
    TrialEnd double
    If the subscription has a trial, the end of that trial.
    TrialFromPlan bool
    Indicates if a plan's trial_period_days should be applied to the subscription. Setting trial_end per subscription is preferred, and this defaults to false. Setting this flag to true together with trial_end is not allowed. See Using trial periods on subscriptions to learn more.
    TrialPeriodDays double
    Integer representing the number of trial period days before the customer is charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. See Using trial periods on subscriptions to learn more.
    TrialSettings SubscriptionTrialSettings
    Settings related to subscription trials.
    AddInvoiceItems []SubscriptionAddInvoiceItemArgs
    A list of prices and quantities that will generate invoice items appended to the next invoice for this subscription. You may pass up to 20 items.
    ApplicationFeePercent float64
    A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account.
    AutomaticTax SubscriptionAutomaticTaxArgs
    BackdateStartDate float64
    A past timestamp to backdate the subscription's start date to. If set, the first invoice will contain line items for the timespan between the start date and the current time. Can be combined with trials and the billing cycle anchor.
    BillingCycleAnchor float64
    The reference point that aligns future billing cycle dates. It sets the day of week for week intervals, the day of month for month and year intervals, and the month of year for year intervals. The timestamp is in UTC format.
    BillingCycleAnchorConfig SubscriptionBillingCycleAnchorConfigArgs
    The fixed values used to calculate the billing_cycle_anchor.
    BillingMode SubscriptionBillingModeArgs
    The billing mode of the subscription.
    BillingSchedules []SubscriptionBillingScheduleArgs
    Billing schedules for this subscription.
    BillingThresholds SubscriptionBillingThresholdsArgs
    Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period
    CancelAt float64
    A date in the future at which the subscription will automatically get canceled
    CancelAtPeriodEnd bool
    Whether this subscription will (if status=active) or did (if status=canceled) cancel at the end of the current billing period.
    CancellationDetails SubscriptionCancellationDetailsArgs
    Details about why this subscription was cancelled
    CollectionMethod string
    Either charge_automatically, or send_invoice. When charging automatically, Stripe will attempt to pay this subscription at the end of the cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as active.
    Currency string
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    Customer string
    ID of the customer who owns the subscription.
    CustomerAccount string
    ID of the account representing the customer who owns the subscription.
    DaysUntilDue float64
    Number of days a customer has to pay invoices generated by this subscription. This value will be null for subscriptions where collection_method=charge_automatically.
    DefaultPaymentMethod string
    ID of the default payment method for the subscription. It must belong to the customer associated with the subscription. This takes precedence over default_source. If neither are set, invoices will use the customer's invoice_settings.default_payment_method or default_source.
    DefaultSource string
    ID of the default payment source for the subscription. It must belong to the customer associated with the subscription and be in a chargeable state. If default_payment_method is also set, default_payment_method will take precedence. If neither are set, invoices will use the customer's invoice_settings.default_payment_method or default_source.
    DefaultTaxRates []string
    The tax rates that will apply to any subscription item that does not have tax_rates set. Invoices created will have their default_tax_rates populated from the subscription.
    Description string
    The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.
    Discounts []SubscriptionDiscountArgs
    The discounts applied to the subscription. Subscription item discounts are applied before subscription discounts. Use expand[]=discounts to expand each discount.
    InvoiceSettings SubscriptionInvoiceSettingsArgs
    Items []SubscriptionItemTypeArgs
    List of subscription items, each with an attached price.
    Metadata map[string]string
    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
    OffSession bool
    Indicates if a customer is on or off-session while an invoice payment is attempted. Defaults to false (on-session).
    OnBehalfOf string
    The account (if any) the charge was made on behalf of for charges associated with this subscription. See the Connect documentation for details.
    PauseCollection SubscriptionPauseCollectionArgs
    If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to paused. Learn more about pausing collection.
    PaymentBehavior string
    Controls how Stripe handles the first invoice when payment is required and collection_method=charge_automatically. Subscriptions with collection_method=send_invoice are automatically activated regardless of the first Invoice status.
    PaymentSettings SubscriptionPaymentSettingsArgs
    Payment settings passed on to invoices created by the subscription.
    PendingInvoiceItemInterval SubscriptionPendingInvoiceItemIntervalArgs
    Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling Create an invoice for the given subscription at the specified interval.
    ProrationBehavior string
    Determines how to handle prorations resulting from the billing_cycle_anchor. If no value is passed, the default is create_prorations.
    TransferData SubscriptionTransferDataArgs
    The account (if any) the subscription's payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the subscription's invoices.
    TrialEnd float64
    If the subscription has a trial, the end of that trial.
    TrialFromPlan bool
    Indicates if a plan's trial_period_days should be applied to the subscription. Setting trial_end per subscription is preferred, and this defaults to false. Setting this flag to true together with trial_end is not allowed. See Using trial periods on subscriptions to learn more.
    TrialPeriodDays float64
    Integer representing the number of trial period days before the customer is charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. See Using trial periods on subscriptions to learn more.
    TrialSettings SubscriptionTrialSettingsArgs
    Settings related to subscription trials.
    add_invoice_items list(object)
    A list of prices and quantities that will generate invoice items appended to the next invoice for this subscription. You may pass up to 20 items.
    application_fee_percent number
    A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account.
    automatic_tax object
    backdate_start_date number
    A past timestamp to backdate the subscription's start date to. If set, the first invoice will contain line items for the timespan between the start date and the current time. Can be combined with trials and the billing cycle anchor.
    billing_cycle_anchor number
    The reference point that aligns future billing cycle dates. It sets the day of week for week intervals, the day of month for month and year intervals, and the month of year for year intervals. The timestamp is in UTC format.
    billing_cycle_anchor_config object
    The fixed values used to calculate the billing_cycle_anchor.
    billing_mode object
    The billing mode of the subscription.
    billing_schedules list(object)
    Billing schedules for this subscription.
    billing_thresholds object
    Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period
    cancel_at number
    A date in the future at which the subscription will automatically get canceled
    cancel_at_period_end bool
    Whether this subscription will (if status=active) or did (if status=canceled) cancel at the end of the current billing period.
    cancellation_details object
    Details about why this subscription was cancelled
    collection_method string
    Either charge_automatically, or send_invoice. When charging automatically, Stripe will attempt to pay this subscription at the end of the cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as active.
    currency string
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    customer string
    ID of the customer who owns the subscription.
    customer_account string
    ID of the account representing the customer who owns the subscription.
    days_until_due number
    Number of days a customer has to pay invoices generated by this subscription. This value will be null for subscriptions where collection_method=charge_automatically.
    default_payment_method string
    ID of the default payment method for the subscription. It must belong to the customer associated with the subscription. This takes precedence over default_source. If neither are set, invoices will use the customer's invoice_settings.default_payment_method or default_source.
    default_source string
    ID of the default payment source for the subscription. It must belong to the customer associated with the subscription and be in a chargeable state. If default_payment_method is also set, default_payment_method will take precedence. If neither are set, invoices will use the customer's invoice_settings.default_payment_method or default_source.
    default_tax_rates list(string)
    The tax rates that will apply to any subscription item that does not have tax_rates set. Invoices created will have their default_tax_rates populated from the subscription.
    description string
    The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.
    discounts list(object)
    The discounts applied to the subscription. Subscription item discounts are applied before subscription discounts. Use expand[]=discounts to expand each discount.
    invoice_settings object
    items list(object)
    List of subscription items, each with an attached price.
    metadata map(string)
    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
    off_session bool
    Indicates if a customer is on or off-session while an invoice payment is attempted. Defaults to false (on-session).
    on_behalf_of string
    The account (if any) the charge was made on behalf of for charges associated with this subscription. See the Connect documentation for details.
    pause_collection object
    If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to paused. Learn more about pausing collection.
    payment_behavior string
    Controls how Stripe handles the first invoice when payment is required and collection_method=charge_automatically. Subscriptions with collection_method=send_invoice are automatically activated regardless of the first Invoice status.
    payment_settings object
    Payment settings passed on to invoices created by the subscription.
    pending_invoice_item_interval object
    Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling Create an invoice for the given subscription at the specified interval.
    proration_behavior string
    Determines how to handle prorations resulting from the billing_cycle_anchor. If no value is passed, the default is create_prorations.
    transfer_data object
    The account (if any) the subscription's payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the subscription's invoices.
    trial_end number
    If the subscription has a trial, the end of that trial.
    trial_from_plan bool
    Indicates if a plan's trial_period_days should be applied to the subscription. Setting trial_end per subscription is preferred, and this defaults to false. Setting this flag to true together with trial_end is not allowed. See Using trial periods on subscriptions to learn more.
    trial_period_days number
    Integer representing the number of trial period days before the customer is charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. See Using trial periods on subscriptions to learn more.
    trial_settings object
    Settings related to subscription trials.
    addInvoiceItems List<SubscriptionAddInvoiceItem>
    A list of prices and quantities that will generate invoice items appended to the next invoice for this subscription. You may pass up to 20 items.
    applicationFeePercent Double
    A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account.
    automaticTax SubscriptionAutomaticTax
    backdateStartDate Double
    A past timestamp to backdate the subscription's start date to. If set, the first invoice will contain line items for the timespan between the start date and the current time. Can be combined with trials and the billing cycle anchor.
    billingCycleAnchor Double
    The reference point that aligns future billing cycle dates. It sets the day of week for week intervals, the day of month for month and year intervals, and the month of year for year intervals. The timestamp is in UTC format.
    billingCycleAnchorConfig SubscriptionBillingCycleAnchorConfig
    The fixed values used to calculate the billing_cycle_anchor.
    billingMode SubscriptionBillingMode
    The billing mode of the subscription.
    billingSchedules List<SubscriptionBillingSchedule>
    Billing schedules for this subscription.
    billingThresholds SubscriptionBillingThresholds
    Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period
    cancelAt Double
    A date in the future at which the subscription will automatically get canceled
    cancelAtPeriodEnd Boolean
    Whether this subscription will (if status=active) or did (if status=canceled) cancel at the end of the current billing period.
    cancellationDetails SubscriptionCancellationDetails
    Details about why this subscription was cancelled
    collectionMethod String
    Either charge_automatically, or send_invoice. When charging automatically, Stripe will attempt to pay this subscription at the end of the cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as active.
    currency String
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    customer String
    ID of the customer who owns the subscription.
    customerAccount String
    ID of the account representing the customer who owns the subscription.
    daysUntilDue Double
    Number of days a customer has to pay invoices generated by this subscription. This value will be null for subscriptions where collection_method=charge_automatically.
    defaultPaymentMethod String
    ID of the default payment method for the subscription. It must belong to the customer associated with the subscription. This takes precedence over default_source. If neither are set, invoices will use the customer's invoice_settings.default_payment_method or default_source.
    defaultSource String
    ID of the default payment source for the subscription. It must belong to the customer associated with the subscription and be in a chargeable state. If default_payment_method is also set, default_payment_method will take precedence. If neither are set, invoices will use the customer's invoice_settings.default_payment_method or default_source.
    defaultTaxRates List<String>
    The tax rates that will apply to any subscription item that does not have tax_rates set. Invoices created will have their default_tax_rates populated from the subscription.
    description String
    The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.
    discounts List<SubscriptionDiscount>
    The discounts applied to the subscription. Subscription item discounts are applied before subscription discounts. Use expand[]=discounts to expand each discount.
    invoiceSettings SubscriptionInvoiceSettings
    items List<SubscriptionItem>
    List of subscription items, each with an attached price.
    metadata Map<String,String>
    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
    offSession Boolean
    Indicates if a customer is on or off-session while an invoice payment is attempted. Defaults to false (on-session).
    onBehalfOf String
    The account (if any) the charge was made on behalf of for charges associated with this subscription. See the Connect documentation for details.
    pauseCollection SubscriptionPauseCollection
    If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to paused. Learn more about pausing collection.
    paymentBehavior String
    Controls how Stripe handles the first invoice when payment is required and collection_method=charge_automatically. Subscriptions with collection_method=send_invoice are automatically activated regardless of the first Invoice status.
    paymentSettings SubscriptionPaymentSettings
    Payment settings passed on to invoices created by the subscription.
    pendingInvoiceItemInterval SubscriptionPendingInvoiceItemInterval
    Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling Create an invoice for the given subscription at the specified interval.
    prorationBehavior String
    Determines how to handle prorations resulting from the billing_cycle_anchor. If no value is passed, the default is create_prorations.
    transferData SubscriptionTransferData
    The account (if any) the subscription's payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the subscription's invoices.
    trialEnd Double
    If the subscription has a trial, the end of that trial.
    trialFromPlan Boolean
    Indicates if a plan's trial_period_days should be applied to the subscription. Setting trial_end per subscription is preferred, and this defaults to false. Setting this flag to true together with trial_end is not allowed. See Using trial periods on subscriptions to learn more.
    trialPeriodDays Double
    Integer representing the number of trial period days before the customer is charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. See Using trial periods on subscriptions to learn more.
    trialSettings SubscriptionTrialSettings
    Settings related to subscription trials.
    addInvoiceItems SubscriptionAddInvoiceItem[]
    A list of prices and quantities that will generate invoice items appended to the next invoice for this subscription. You may pass up to 20 items.
    applicationFeePercent number
    A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account.
    automaticTax SubscriptionAutomaticTax
    backdateStartDate number
    A past timestamp to backdate the subscription's start date to. If set, the first invoice will contain line items for the timespan between the start date and the current time. Can be combined with trials and the billing cycle anchor.
    billingCycleAnchor number
    The reference point that aligns future billing cycle dates. It sets the day of week for week intervals, the day of month for month and year intervals, and the month of year for year intervals. The timestamp is in UTC format.
    billingCycleAnchorConfig SubscriptionBillingCycleAnchorConfig
    The fixed values used to calculate the billing_cycle_anchor.
    billingMode SubscriptionBillingMode
    The billing mode of the subscription.
    billingSchedules SubscriptionBillingSchedule[]
    Billing schedules for this subscription.
    billingThresholds SubscriptionBillingThresholds
    Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period
    cancelAt number
    A date in the future at which the subscription will automatically get canceled
    cancelAtPeriodEnd boolean
    Whether this subscription will (if status=active) or did (if status=canceled) cancel at the end of the current billing period.
    cancellationDetails SubscriptionCancellationDetails
    Details about why this subscription was cancelled
    collectionMethod string
    Either charge_automatically, or send_invoice. When charging automatically, Stripe will attempt to pay this subscription at the end of the cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as active.
    currency string
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    customer string
    ID of the customer who owns the subscription.
    customerAccount string
    ID of the account representing the customer who owns the subscription.
    daysUntilDue number
    Number of days a customer has to pay invoices generated by this subscription. This value will be null for subscriptions where collection_method=charge_automatically.
    defaultPaymentMethod string
    ID of the default payment method for the subscription. It must belong to the customer associated with the subscription. This takes precedence over default_source. If neither are set, invoices will use the customer's invoice_settings.default_payment_method or default_source.
    defaultSource string
    ID of the default payment source for the subscription. It must belong to the customer associated with the subscription and be in a chargeable state. If default_payment_method is also set, default_payment_method will take precedence. If neither are set, invoices will use the customer's invoice_settings.default_payment_method or default_source.
    defaultTaxRates string[]
    The tax rates that will apply to any subscription item that does not have tax_rates set. Invoices created will have their default_tax_rates populated from the subscription.
    description string
    The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.
    discounts SubscriptionDiscount[]
    The discounts applied to the subscription. Subscription item discounts are applied before subscription discounts. Use expand[]=discounts to expand each discount.
    invoiceSettings SubscriptionInvoiceSettings
    items SubscriptionItem[]
    List of subscription items, each with an attached price.
    metadata {[key: string]: string}
    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
    offSession boolean
    Indicates if a customer is on or off-session while an invoice payment is attempted. Defaults to false (on-session).
    onBehalfOf string
    The account (if any) the charge was made on behalf of for charges associated with this subscription. See the Connect documentation for details.
    pauseCollection SubscriptionPauseCollection
    If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to paused. Learn more about pausing collection.
    paymentBehavior string
    Controls how Stripe handles the first invoice when payment is required and collection_method=charge_automatically. Subscriptions with collection_method=send_invoice are automatically activated regardless of the first Invoice status.
    paymentSettings SubscriptionPaymentSettings
    Payment settings passed on to invoices created by the subscription.
    pendingInvoiceItemInterval SubscriptionPendingInvoiceItemInterval
    Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling Create an invoice for the given subscription at the specified interval.
    prorationBehavior string
    Determines how to handle prorations resulting from the billing_cycle_anchor. If no value is passed, the default is create_prorations.
    transferData SubscriptionTransferData
    The account (if any) the subscription's payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the subscription's invoices.
    trialEnd number
    If the subscription has a trial, the end of that trial.
    trialFromPlan boolean
    Indicates if a plan's trial_period_days should be applied to the subscription. Setting trial_end per subscription is preferred, and this defaults to false. Setting this flag to true together with trial_end is not allowed. See Using trial periods on subscriptions to learn more.
    trialPeriodDays number
    Integer representing the number of trial period days before the customer is charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. See Using trial periods on subscriptions to learn more.
    trialSettings SubscriptionTrialSettings
    Settings related to subscription trials.
    add_invoice_items Sequence[SubscriptionAddInvoiceItemArgs]
    A list of prices and quantities that will generate invoice items appended to the next invoice for this subscription. You may pass up to 20 items.
    application_fee_percent float
    A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account.
    automatic_tax SubscriptionAutomaticTaxArgs
    backdate_start_date float
    A past timestamp to backdate the subscription's start date to. If set, the first invoice will contain line items for the timespan between the start date and the current time. Can be combined with trials and the billing cycle anchor.
    billing_cycle_anchor float
    The reference point that aligns future billing cycle dates. It sets the day of week for week intervals, the day of month for month and year intervals, and the month of year for year intervals. The timestamp is in UTC format.
    billing_cycle_anchor_config SubscriptionBillingCycleAnchorConfigArgs
    The fixed values used to calculate the billing_cycle_anchor.
    billing_mode SubscriptionBillingModeArgs
    The billing mode of the subscription.
    billing_schedules Sequence[SubscriptionBillingScheduleArgs]
    Billing schedules for this subscription.
    billing_thresholds SubscriptionBillingThresholdsArgs
    Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period
    cancel_at float
    A date in the future at which the subscription will automatically get canceled
    cancel_at_period_end bool
    Whether this subscription will (if status=active) or did (if status=canceled) cancel at the end of the current billing period.
    cancellation_details SubscriptionCancellationDetailsArgs
    Details about why this subscription was cancelled
    collection_method str
    Either charge_automatically, or send_invoice. When charging automatically, Stripe will attempt to pay this subscription at the end of the cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as active.
    currency str
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    customer str
    ID of the customer who owns the subscription.
    customer_account str
    ID of the account representing the customer who owns the subscription.
    days_until_due float
    Number of days a customer has to pay invoices generated by this subscription. This value will be null for subscriptions where collection_method=charge_automatically.
    default_payment_method str
    ID of the default payment method for the subscription. It must belong to the customer associated with the subscription. This takes precedence over default_source. If neither are set, invoices will use the customer's invoice_settings.default_payment_method or default_source.
    default_source str
    ID of the default payment source for the subscription. It must belong to the customer associated with the subscription and be in a chargeable state. If default_payment_method is also set, default_payment_method will take precedence. If neither are set, invoices will use the customer's invoice_settings.default_payment_method or default_source.
    default_tax_rates Sequence[str]
    The tax rates that will apply to any subscription item that does not have tax_rates set. Invoices created will have their default_tax_rates populated from the subscription.
    description str
    The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.
    discounts Sequence[SubscriptionDiscountArgs]
    The discounts applied to the subscription. Subscription item discounts are applied before subscription discounts. Use expand[]=discounts to expand each discount.
    invoice_settings SubscriptionInvoiceSettingsArgs
    items Sequence[SubscriptionItemArgs]
    List of subscription items, each with an attached price.
    metadata Mapping[str, str]
    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
    off_session bool
    Indicates if a customer is on or off-session while an invoice payment is attempted. Defaults to false (on-session).
    on_behalf_of str
    The account (if any) the charge was made on behalf of for charges associated with this subscription. See the Connect documentation for details.
    pause_collection SubscriptionPauseCollectionArgs
    If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to paused. Learn more about pausing collection.
    payment_behavior str
    Controls how Stripe handles the first invoice when payment is required and collection_method=charge_automatically. Subscriptions with collection_method=send_invoice are automatically activated regardless of the first Invoice status.
    payment_settings SubscriptionPaymentSettingsArgs
    Payment settings passed on to invoices created by the subscription.
    pending_invoice_item_interval SubscriptionPendingInvoiceItemIntervalArgs
    Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling Create an invoice for the given subscription at the specified interval.
    proration_behavior str
    Determines how to handle prorations resulting from the billing_cycle_anchor. If no value is passed, the default is create_prorations.
    transfer_data SubscriptionTransferDataArgs
    The account (if any) the subscription's payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the subscription's invoices.
    trial_end float
    If the subscription has a trial, the end of that trial.
    trial_from_plan bool
    Indicates if a plan's trial_period_days should be applied to the subscription. Setting trial_end per subscription is preferred, and this defaults to false. Setting this flag to true together with trial_end is not allowed. See Using trial periods on subscriptions to learn more.
    trial_period_days float
    Integer representing the number of trial period days before the customer is charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. See Using trial periods on subscriptions to learn more.
    trial_settings SubscriptionTrialSettingsArgs
    Settings related to subscription trials.
    addInvoiceItems List<Property Map>
    A list of prices and quantities that will generate invoice items appended to the next invoice for this subscription. You may pass up to 20 items.
    applicationFeePercent Number
    A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account.
    automaticTax Property Map
    backdateStartDate Number
    A past timestamp to backdate the subscription's start date to. If set, the first invoice will contain line items for the timespan between the start date and the current time. Can be combined with trials and the billing cycle anchor.
    billingCycleAnchor Number
    The reference point that aligns future billing cycle dates. It sets the day of week for week intervals, the day of month for month and year intervals, and the month of year for year intervals. The timestamp is in UTC format.
    billingCycleAnchorConfig Property Map
    The fixed values used to calculate the billing_cycle_anchor.
    billingMode Property Map
    The billing mode of the subscription.
    billingSchedules List<Property Map>
    Billing schedules for this subscription.
    billingThresholds Property Map
    Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period
    cancelAt Number
    A date in the future at which the subscription will automatically get canceled
    cancelAtPeriodEnd Boolean
    Whether this subscription will (if status=active) or did (if status=canceled) cancel at the end of the current billing period.
    cancellationDetails Property Map
    Details about why this subscription was cancelled
    collectionMethod String
    Either charge_automatically, or send_invoice. When charging automatically, Stripe will attempt to pay this subscription at the end of the cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as active.
    currency String
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    customer String
    ID of the customer who owns the subscription.
    customerAccount String
    ID of the account representing the customer who owns the subscription.
    daysUntilDue Number
    Number of days a customer has to pay invoices generated by this subscription. This value will be null for subscriptions where collection_method=charge_automatically.
    defaultPaymentMethod String
    ID of the default payment method for the subscription. It must belong to the customer associated with the subscription. This takes precedence over default_source. If neither are set, invoices will use the customer's invoice_settings.default_payment_method or default_source.
    defaultSource String
    ID of the default payment source for the subscription. It must belong to the customer associated with the subscription and be in a chargeable state. If default_payment_method is also set, default_payment_method will take precedence. If neither are set, invoices will use the customer's invoice_settings.default_payment_method or default_source.
    defaultTaxRates List<String>
    The tax rates that will apply to any subscription item that does not have tax_rates set. Invoices created will have their default_tax_rates populated from the subscription.
    description String
    The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.
    discounts List<Property Map>
    The discounts applied to the subscription. Subscription item discounts are applied before subscription discounts. Use expand[]=discounts to expand each discount.
    invoiceSettings Property Map
    items List<Property Map>
    List of subscription items, each with an attached price.
    metadata Map<String>
    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
    offSession Boolean
    Indicates if a customer is on or off-session while an invoice payment is attempted. Defaults to false (on-session).
    onBehalfOf String
    The account (if any) the charge was made on behalf of for charges associated with this subscription. See the Connect documentation for details.
    pauseCollection Property Map
    If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to paused. Learn more about pausing collection.
    paymentBehavior String
    Controls how Stripe handles the first invoice when payment is required and collection_method=charge_automatically. Subscriptions with collection_method=send_invoice are automatically activated regardless of the first Invoice status.
    paymentSettings Property Map
    Payment settings passed on to invoices created by the subscription.
    pendingInvoiceItemInterval Property Map
    Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling Create an invoice for the given subscription at the specified interval.
    prorationBehavior String
    Determines how to handle prorations resulting from the billing_cycle_anchor. If no value is passed, the default is create_prorations.
    transferData Property Map
    The account (if any) the subscription's payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the subscription's invoices.
    trialEnd Number
    If the subscription has a trial, the end of that trial.
    trialFromPlan Boolean
    Indicates if a plan's trial_period_days should be applied to the subscription. Setting trial_end per subscription is preferred, and this defaults to false. Setting this flag to true together with trial_end is not allowed. See Using trial periods on subscriptions to learn more.
    trialPeriodDays Number
    Integer representing the number of trial period days before the customer is charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. See Using trial periods on subscriptions to learn more.
    trialSettings Property Map
    Settings related to subscription trials.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Subscription resource produces the following output properties:

    Application string
    ID of the Connect Application that created the subscription.
    CanceledAt double
    If the subscription has been canceled, the date of that cancellation. If the subscription was canceled with cancel_at_period_end, canceled_at will reflect the time of the most recent update request, not the end of the subscription period when the subscription is automatically moved to a canceled state.
    Created double
    Time at which the object was created. Measured in seconds since the Unix epoch.
    EndedAt double
    If the subscription has ended, the date the subscription ended.
    Id string
    The provider-assigned unique ID for this managed resource.
    Livemode bool
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    ManagedPayments SubscriptionManagedPayments
    Settings for Managed Payments for this Subscription and resulting Invoices and PaymentIntents.
    NextPendingInvoiceItemInvoice double
    Specifies the approximate timestamp on which any pending invoice items will be billed according to the schedule provided at pending_invoice_item_interval.
    Object string
    String representing the object's type. Objects of the same type share the same value.
    PendingSetupIntent string
    You can use this SetupIntent to collect user authentication when creating a subscription without immediate payment or updating a subscription's payment method, allowing you to optimize for off-session payments. Learn more in the SCA Migration Guide.
    PendingUpdate SubscriptionPendingUpdate
    If specified, pending updates that will be applied to the subscription once the latest_invoice has been paid.
    PresentmentDetails SubscriptionPresentmentDetails
    Schedule string
    The schedule attached to the subscription
    StartDate double
    Date when the subscription was first created. The date might differ from the created date due to backdating.
    Status string

    Possible values are incomplete, incomplete_expired, trialing, active, past_due, canceled, unpaid, or paused.

    For collection_method=charge_automatically a subscription moves into incomplete if the initial payment attempt fails. A subscription in this status can only have metadata and default_source updated. Once the first invoice is paid, the subscription moves into an active status. If the first invoice is not paid within 23 hours, the subscription transitions to incomplete_expired. This is a terminal status, the open invoice will be voided and no further invoices will be generated.

    A subscription that is currently in a trial period is trialing and moves to active when the trial period is over.

    A subscription can only enter a paused status when a trial ends without a payment method. A paused subscription doesn't generate invoices and can be resumed after your customer adds their payment method. The paused status is different from pausing collection, which still generates invoices and leaves the subscription's status unchanged.

    If subscription collection_method=charge_automatically, it becomes past_due when payment is required but cannot be paid (due to failed payment or awaiting additional user actions). Once Stripe has exhausted all payment retry attempts, the subscription will become canceled or unpaid (depending on your subscriptions settings).

    If subscription collection_method=send_invoice it becomes past_due when its invoice is not paid by the due date, and canceled or unpaid if it is still not paid by an additional deadline after that. Note that when a subscription has a status of unpaid, no subsequent invoices will be attempted (invoices will be created, but then immediately automatically closed). After receiving updated payment information from a customer, you may choose to reopen and pay their closed invoices.

    TestClock string
    ID of the test clock this subscription belongs to.
    TrialStart double
    If the subscription has a trial, the beginning of that trial.
    Application string
    ID of the Connect Application that created the subscription.
    CanceledAt float64
    If the subscription has been canceled, the date of that cancellation. If the subscription was canceled with cancel_at_period_end, canceled_at will reflect the time of the most recent update request, not the end of the subscription period when the subscription is automatically moved to a canceled state.
    Created float64
    Time at which the object was created. Measured in seconds since the Unix epoch.
    EndedAt float64
    If the subscription has ended, the date the subscription ended.
    Id string
    The provider-assigned unique ID for this managed resource.
    Livemode bool
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    ManagedPayments SubscriptionManagedPayments
    Settings for Managed Payments for this Subscription and resulting Invoices and PaymentIntents.
    NextPendingInvoiceItemInvoice float64
    Specifies the approximate timestamp on which any pending invoice items will be billed according to the schedule provided at pending_invoice_item_interval.
    Object string
    String representing the object's type. Objects of the same type share the same value.
    PendingSetupIntent string
    You can use this SetupIntent to collect user authentication when creating a subscription without immediate payment or updating a subscription's payment method, allowing you to optimize for off-session payments. Learn more in the SCA Migration Guide.
    PendingUpdate SubscriptionPendingUpdate
    If specified, pending updates that will be applied to the subscription once the latest_invoice has been paid.
    PresentmentDetails SubscriptionPresentmentDetails
    Schedule string
    The schedule attached to the subscription
    StartDate float64
    Date when the subscription was first created. The date might differ from the created date due to backdating.
    Status string

    Possible values are incomplete, incomplete_expired, trialing, active, past_due, canceled, unpaid, or paused.

    For collection_method=charge_automatically a subscription moves into incomplete if the initial payment attempt fails. A subscription in this status can only have metadata and default_source updated. Once the first invoice is paid, the subscription moves into an active status. If the first invoice is not paid within 23 hours, the subscription transitions to incomplete_expired. This is a terminal status, the open invoice will be voided and no further invoices will be generated.

    A subscription that is currently in a trial period is trialing and moves to active when the trial period is over.

    A subscription can only enter a paused status when a trial ends without a payment method. A paused subscription doesn't generate invoices and can be resumed after your customer adds their payment method. The paused status is different from pausing collection, which still generates invoices and leaves the subscription's status unchanged.

    If subscription collection_method=charge_automatically, it becomes past_due when payment is required but cannot be paid (due to failed payment or awaiting additional user actions). Once Stripe has exhausted all payment retry attempts, the subscription will become canceled or unpaid (depending on your subscriptions settings).

    If subscription collection_method=send_invoice it becomes past_due when its invoice is not paid by the due date, and canceled or unpaid if it is still not paid by an additional deadline after that. Note that when a subscription has a status of unpaid, no subsequent invoices will be attempted (invoices will be created, but then immediately automatically closed). After receiving updated payment information from a customer, you may choose to reopen and pay their closed invoices.

    TestClock string
    ID of the test clock this subscription belongs to.
    TrialStart float64
    If the subscription has a trial, the beginning of that trial.
    application string
    ID of the Connect Application that created the subscription.
    canceled_at number
    If the subscription has been canceled, the date of that cancellation. If the subscription was canceled with cancel_at_period_end, canceled_at will reflect the time of the most recent update request, not the end of the subscription period when the subscription is automatically moved to a canceled state.
    created number
    Time at which the object was created. Measured in seconds since the Unix epoch.
    ended_at number
    If the subscription has ended, the date the subscription ended.
    id string
    The provider-assigned unique ID for this managed resource.
    livemode bool
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    managed_payments object
    Settings for Managed Payments for this Subscription and resulting Invoices and PaymentIntents.
    next_pending_invoice_item_invoice number
    Specifies the approximate timestamp on which any pending invoice items will be billed according to the schedule provided at pending_invoice_item_interval.
    object string
    String representing the object's type. Objects of the same type share the same value.
    pending_setup_intent string
    You can use this SetupIntent to collect user authentication when creating a subscription without immediate payment or updating a subscription's payment method, allowing you to optimize for off-session payments. Learn more in the SCA Migration Guide.
    pending_update object
    If specified, pending updates that will be applied to the subscription once the latest_invoice has been paid.
    presentment_details object
    schedule string
    The schedule attached to the subscription
    start_date number
    Date when the subscription was first created. The date might differ from the created date due to backdating.
    status string

    Possible values are incomplete, incomplete_expired, trialing, active, past_due, canceled, unpaid, or paused.

    For collection_method=charge_automatically a subscription moves into incomplete if the initial payment attempt fails. A subscription in this status can only have metadata and default_source updated. Once the first invoice is paid, the subscription moves into an active status. If the first invoice is not paid within 23 hours, the subscription transitions to incomplete_expired. This is a terminal status, the open invoice will be voided and no further invoices will be generated.

    A subscription that is currently in a trial period is trialing and moves to active when the trial period is over.

    A subscription can only enter a paused status when a trial ends without a payment method. A paused subscription doesn't generate invoices and can be resumed after your customer adds their payment method. The paused status is different from pausing collection, which still generates invoices and leaves the subscription's status unchanged.

    If subscription collection_method=charge_automatically, it becomes past_due when payment is required but cannot be paid (due to failed payment or awaiting additional user actions). Once Stripe has exhausted all payment retry attempts, the subscription will become canceled or unpaid (depending on your subscriptions settings).

    If subscription collection_method=send_invoice it becomes past_due when its invoice is not paid by the due date, and canceled or unpaid if it is still not paid by an additional deadline after that. Note that when a subscription has a status of unpaid, no subsequent invoices will be attempted (invoices will be created, but then immediately automatically closed). After receiving updated payment information from a customer, you may choose to reopen and pay their closed invoices.

    test_clock string
    ID of the test clock this subscription belongs to.
    trial_start number
    If the subscription has a trial, the beginning of that trial.
    application String
    ID of the Connect Application that created the subscription.
    canceledAt Double
    If the subscription has been canceled, the date of that cancellation. If the subscription was canceled with cancel_at_period_end, canceled_at will reflect the time of the most recent update request, not the end of the subscription period when the subscription is automatically moved to a canceled state.
    created Double
    Time at which the object was created. Measured in seconds since the Unix epoch.
    endedAt Double
    If the subscription has ended, the date the subscription ended.
    id String
    The provider-assigned unique ID for this managed resource.
    livemode Boolean
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    managedPayments SubscriptionManagedPayments
    Settings for Managed Payments for this Subscription and resulting Invoices and PaymentIntents.
    nextPendingInvoiceItemInvoice Double
    Specifies the approximate timestamp on which any pending invoice items will be billed according to the schedule provided at pending_invoice_item_interval.
    object String
    String representing the object's type. Objects of the same type share the same value.
    pendingSetupIntent String
    You can use this SetupIntent to collect user authentication when creating a subscription without immediate payment or updating a subscription's payment method, allowing you to optimize for off-session payments. Learn more in the SCA Migration Guide.
    pendingUpdate SubscriptionPendingUpdate
    If specified, pending updates that will be applied to the subscription once the latest_invoice has been paid.
    presentmentDetails SubscriptionPresentmentDetails
    schedule String
    The schedule attached to the subscription
    startDate Double
    Date when the subscription was first created. The date might differ from the created date due to backdating.
    status String

    Possible values are incomplete, incomplete_expired, trialing, active, past_due, canceled, unpaid, or paused.

    For collection_method=charge_automatically a subscription moves into incomplete if the initial payment attempt fails. A subscription in this status can only have metadata and default_source updated. Once the first invoice is paid, the subscription moves into an active status. If the first invoice is not paid within 23 hours, the subscription transitions to incomplete_expired. This is a terminal status, the open invoice will be voided and no further invoices will be generated.

    A subscription that is currently in a trial period is trialing and moves to active when the trial period is over.

    A subscription can only enter a paused status when a trial ends without a payment method. A paused subscription doesn't generate invoices and can be resumed after your customer adds their payment method. The paused status is different from pausing collection, which still generates invoices and leaves the subscription's status unchanged.

    If subscription collection_method=charge_automatically, it becomes past_due when payment is required but cannot be paid (due to failed payment or awaiting additional user actions). Once Stripe has exhausted all payment retry attempts, the subscription will become canceled or unpaid (depending on your subscriptions settings).

    If subscription collection_method=send_invoice it becomes past_due when its invoice is not paid by the due date, and canceled or unpaid if it is still not paid by an additional deadline after that. Note that when a subscription has a status of unpaid, no subsequent invoices will be attempted (invoices will be created, but then immediately automatically closed). After receiving updated payment information from a customer, you may choose to reopen and pay their closed invoices.

    testClock String
    ID of the test clock this subscription belongs to.
    trialStart Double
    If the subscription has a trial, the beginning of that trial.
    application string
    ID of the Connect Application that created the subscription.
    canceledAt number
    If the subscription has been canceled, the date of that cancellation. If the subscription was canceled with cancel_at_period_end, canceled_at will reflect the time of the most recent update request, not the end of the subscription period when the subscription is automatically moved to a canceled state.
    created number
    Time at which the object was created. Measured in seconds since the Unix epoch.
    endedAt number
    If the subscription has ended, the date the subscription ended.
    id string
    The provider-assigned unique ID for this managed resource.
    livemode boolean
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    managedPayments SubscriptionManagedPayments
    Settings for Managed Payments for this Subscription and resulting Invoices and PaymentIntents.
    nextPendingInvoiceItemInvoice number
    Specifies the approximate timestamp on which any pending invoice items will be billed according to the schedule provided at pending_invoice_item_interval.
    object string
    String representing the object's type. Objects of the same type share the same value.
    pendingSetupIntent string
    You can use this SetupIntent to collect user authentication when creating a subscription without immediate payment or updating a subscription's payment method, allowing you to optimize for off-session payments. Learn more in the SCA Migration Guide.
    pendingUpdate SubscriptionPendingUpdate
    If specified, pending updates that will be applied to the subscription once the latest_invoice has been paid.
    presentmentDetails SubscriptionPresentmentDetails
    schedule string
    The schedule attached to the subscription
    startDate number
    Date when the subscription was first created. The date might differ from the created date due to backdating.
    status string

    Possible values are incomplete, incomplete_expired, trialing, active, past_due, canceled, unpaid, or paused.

    For collection_method=charge_automatically a subscription moves into incomplete if the initial payment attempt fails. A subscription in this status can only have metadata and default_source updated. Once the first invoice is paid, the subscription moves into an active status. If the first invoice is not paid within 23 hours, the subscription transitions to incomplete_expired. This is a terminal status, the open invoice will be voided and no further invoices will be generated.

    A subscription that is currently in a trial period is trialing and moves to active when the trial period is over.

    A subscription can only enter a paused status when a trial ends without a payment method. A paused subscription doesn't generate invoices and can be resumed after your customer adds their payment method. The paused status is different from pausing collection, which still generates invoices and leaves the subscription's status unchanged.

    If subscription collection_method=charge_automatically, it becomes past_due when payment is required but cannot be paid (due to failed payment or awaiting additional user actions). Once Stripe has exhausted all payment retry attempts, the subscription will become canceled or unpaid (depending on your subscriptions settings).

    If subscription collection_method=send_invoice it becomes past_due when its invoice is not paid by the due date, and canceled or unpaid if it is still not paid by an additional deadline after that. Note that when a subscription has a status of unpaid, no subsequent invoices will be attempted (invoices will be created, but then immediately automatically closed). After receiving updated payment information from a customer, you may choose to reopen and pay their closed invoices.

    testClock string
    ID of the test clock this subscription belongs to.
    trialStart number
    If the subscription has a trial, the beginning of that trial.
    application str
    ID of the Connect Application that created the subscription.
    canceled_at float
    If the subscription has been canceled, the date of that cancellation. If the subscription was canceled with cancel_at_period_end, canceled_at will reflect the time of the most recent update request, not the end of the subscription period when the subscription is automatically moved to a canceled state.
    created float
    Time at which the object was created. Measured in seconds since the Unix epoch.
    ended_at float
    If the subscription has ended, the date the subscription ended.
    id str
    The provider-assigned unique ID for this managed resource.
    livemode bool
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    managed_payments SubscriptionManagedPayments
    Settings for Managed Payments for this Subscription and resulting Invoices and PaymentIntents.
    next_pending_invoice_item_invoice float
    Specifies the approximate timestamp on which any pending invoice items will be billed according to the schedule provided at pending_invoice_item_interval.
    object str
    String representing the object's type. Objects of the same type share the same value.
    pending_setup_intent str
    You can use this SetupIntent to collect user authentication when creating a subscription without immediate payment or updating a subscription's payment method, allowing you to optimize for off-session payments. Learn more in the SCA Migration Guide.
    pending_update SubscriptionPendingUpdate
    If specified, pending updates that will be applied to the subscription once the latest_invoice has been paid.
    presentment_details SubscriptionPresentmentDetails
    schedule str
    The schedule attached to the subscription
    start_date float
    Date when the subscription was first created. The date might differ from the created date due to backdating.
    status str

    Possible values are incomplete, incomplete_expired, trialing, active, past_due, canceled, unpaid, or paused.

    For collection_method=charge_automatically a subscription moves into incomplete if the initial payment attempt fails. A subscription in this status can only have metadata and default_source updated. Once the first invoice is paid, the subscription moves into an active status. If the first invoice is not paid within 23 hours, the subscription transitions to incomplete_expired. This is a terminal status, the open invoice will be voided and no further invoices will be generated.

    A subscription that is currently in a trial period is trialing and moves to active when the trial period is over.

    A subscription can only enter a paused status when a trial ends without a payment method. A paused subscription doesn't generate invoices and can be resumed after your customer adds their payment method. The paused status is different from pausing collection, which still generates invoices and leaves the subscription's status unchanged.

    If subscription collection_method=charge_automatically, it becomes past_due when payment is required but cannot be paid (due to failed payment or awaiting additional user actions). Once Stripe has exhausted all payment retry attempts, the subscription will become canceled or unpaid (depending on your subscriptions settings).

    If subscription collection_method=send_invoice it becomes past_due when its invoice is not paid by the due date, and canceled or unpaid if it is still not paid by an additional deadline after that. Note that when a subscription has a status of unpaid, no subsequent invoices will be attempted (invoices will be created, but then immediately automatically closed). After receiving updated payment information from a customer, you may choose to reopen and pay their closed invoices.

    test_clock str
    ID of the test clock this subscription belongs to.
    trial_start float
    If the subscription has a trial, the beginning of that trial.
    application String
    ID of the Connect Application that created the subscription.
    canceledAt Number
    If the subscription has been canceled, the date of that cancellation. If the subscription was canceled with cancel_at_period_end, canceled_at will reflect the time of the most recent update request, not the end of the subscription period when the subscription is automatically moved to a canceled state.
    created Number
    Time at which the object was created. Measured in seconds since the Unix epoch.
    endedAt Number
    If the subscription has ended, the date the subscription ended.
    id String
    The provider-assigned unique ID for this managed resource.
    livemode Boolean
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    managedPayments Property Map
    Settings for Managed Payments for this Subscription and resulting Invoices and PaymentIntents.
    nextPendingInvoiceItemInvoice Number
    Specifies the approximate timestamp on which any pending invoice items will be billed according to the schedule provided at pending_invoice_item_interval.
    object String
    String representing the object's type. Objects of the same type share the same value.
    pendingSetupIntent String
    You can use this SetupIntent to collect user authentication when creating a subscription without immediate payment or updating a subscription's payment method, allowing you to optimize for off-session payments. Learn more in the SCA Migration Guide.
    pendingUpdate Property Map
    If specified, pending updates that will be applied to the subscription once the latest_invoice has been paid.
    presentmentDetails Property Map
    schedule String
    The schedule attached to the subscription
    startDate Number
    Date when the subscription was first created. The date might differ from the created date due to backdating.
    status String

    Possible values are incomplete, incomplete_expired, trialing, active, past_due, canceled, unpaid, or paused.

    For collection_method=charge_automatically a subscription moves into incomplete if the initial payment attempt fails. A subscription in this status can only have metadata and default_source updated. Once the first invoice is paid, the subscription moves into an active status. If the first invoice is not paid within 23 hours, the subscription transitions to incomplete_expired. This is a terminal status, the open invoice will be voided and no further invoices will be generated.

    A subscription that is currently in a trial period is trialing and moves to active when the trial period is over.

    A subscription can only enter a paused status when a trial ends without a payment method. A paused subscription doesn't generate invoices and can be resumed after your customer adds their payment method. The paused status is different from pausing collection, which still generates invoices and leaves the subscription's status unchanged.

    If subscription collection_method=charge_automatically, it becomes past_due when payment is required but cannot be paid (due to failed payment or awaiting additional user actions). Once Stripe has exhausted all payment retry attempts, the subscription will become canceled or unpaid (depending on your subscriptions settings).

    If subscription collection_method=send_invoice it becomes past_due when its invoice is not paid by the due date, and canceled or unpaid if it is still not paid by an additional deadline after that. Note that when a subscription has a status of unpaid, no subsequent invoices will be attempted (invoices will be created, but then immediately automatically closed). After receiving updated payment information from a customer, you may choose to reopen and pay their closed invoices.

    testClock String
    ID of the test clock this subscription belongs to.
    trialStart Number
    If the subscription has a trial, the beginning of that trial.

    Look up Existing Subscription Resource

    Get an existing Subscription resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: SubscriptionState, opts?: CustomResourceOptions): Subscription
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        add_invoice_items: Optional[Sequence[SubscriptionAddInvoiceItemArgs]] = None,
        application: Optional[str] = None,
        application_fee_percent: Optional[float] = None,
        automatic_tax: Optional[SubscriptionAutomaticTaxArgs] = None,
        backdate_start_date: Optional[float] = None,
        billing_cycle_anchor: Optional[float] = None,
        billing_cycle_anchor_config: Optional[SubscriptionBillingCycleAnchorConfigArgs] = None,
        billing_mode: Optional[SubscriptionBillingModeArgs] = None,
        billing_schedules: Optional[Sequence[SubscriptionBillingScheduleArgs]] = None,
        billing_thresholds: Optional[SubscriptionBillingThresholdsArgs] = None,
        cancel_at: Optional[float] = None,
        cancel_at_period_end: Optional[bool] = None,
        canceled_at: Optional[float] = None,
        cancellation_details: Optional[SubscriptionCancellationDetailsArgs] = None,
        collection_method: Optional[str] = None,
        created: Optional[float] = None,
        currency: Optional[str] = None,
        customer: Optional[str] = None,
        customer_account: Optional[str] = None,
        days_until_due: Optional[float] = None,
        default_payment_method: Optional[str] = None,
        default_source: Optional[str] = None,
        default_tax_rates: Optional[Sequence[str]] = None,
        description: Optional[str] = None,
        discounts: Optional[Sequence[SubscriptionDiscountArgs]] = None,
        ended_at: Optional[float] = None,
        invoice_settings: Optional[SubscriptionInvoiceSettingsArgs] = None,
        items: Optional[Sequence[SubscriptionItemArgs]] = None,
        livemode: Optional[bool] = None,
        managed_payments: Optional[SubscriptionManagedPaymentsArgs] = None,
        metadata: Optional[Mapping[str, str]] = None,
        next_pending_invoice_item_invoice: Optional[float] = None,
        object: Optional[str] = None,
        off_session: Optional[bool] = None,
        on_behalf_of: Optional[str] = None,
        pause_collection: Optional[SubscriptionPauseCollectionArgs] = None,
        payment_behavior: Optional[str] = None,
        payment_settings: Optional[SubscriptionPaymentSettingsArgs] = None,
        pending_invoice_item_interval: Optional[SubscriptionPendingInvoiceItemIntervalArgs] = None,
        pending_setup_intent: Optional[str] = None,
        pending_update: Optional[SubscriptionPendingUpdateArgs] = None,
        presentment_details: Optional[SubscriptionPresentmentDetailsArgs] = None,
        proration_behavior: Optional[str] = None,
        schedule: Optional[str] = None,
        start_date: Optional[float] = None,
        status: Optional[str] = None,
        test_clock: Optional[str] = None,
        transfer_data: Optional[SubscriptionTransferDataArgs] = None,
        trial_end: Optional[float] = None,
        trial_from_plan: Optional[bool] = None,
        trial_period_days: Optional[float] = None,
        trial_settings: Optional[SubscriptionTrialSettingsArgs] = None,
        trial_start: Optional[float] = None) -> Subscription
    func GetSubscription(ctx *Context, name string, id IDInput, state *SubscriptionState, opts ...ResourceOption) (*Subscription, error)
    public static Subscription Get(string name, Input<string> id, SubscriptionState? state, CustomResourceOptions? opts = null)
    public static Subscription get(String name, Output<String> id, SubscriptionState state, CustomResourceOptions options)
    resources:  _:    type: stripe:Subscription    get:      id: ${id}
    import {
  to = stripe_subscription.example
  id = "${id}"
}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AddInvoiceItems List<SubscriptionAddInvoiceItem>
    A list of prices and quantities that will generate invoice items appended to the next invoice for this subscription. You may pass up to 20 items.
    Application string
    ID of the Connect Application that created the subscription.
    ApplicationFeePercent double
    A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account.
    AutomaticTax SubscriptionAutomaticTax
    BackdateStartDate double
    A past timestamp to backdate the subscription's start date to. If set, the first invoice will contain line items for the timespan between the start date and the current time. Can be combined with trials and the billing cycle anchor.
    BillingCycleAnchor double
    The reference point that aligns future billing cycle dates. It sets the day of week for week intervals, the day of month for month and year intervals, and the month of year for year intervals. The timestamp is in UTC format.
    BillingCycleAnchorConfig SubscriptionBillingCycleAnchorConfig
    The fixed values used to calculate the billing_cycle_anchor.
    BillingMode SubscriptionBillingMode
    The billing mode of the subscription.
    BillingSchedules List<SubscriptionBillingSchedule>
    Billing schedules for this subscription.
    BillingThresholds SubscriptionBillingThresholds
    Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period
    CancelAt double
    A date in the future at which the subscription will automatically get canceled
    CancelAtPeriodEnd bool
    Whether this subscription will (if status=active) or did (if status=canceled) cancel at the end of the current billing period.
    CanceledAt double
    If the subscription has been canceled, the date of that cancellation. If the subscription was canceled with cancel_at_period_end, canceled_at will reflect the time of the most recent update request, not the end of the subscription period when the subscription is automatically moved to a canceled state.
    CancellationDetails SubscriptionCancellationDetails
    Details about why this subscription was cancelled
    CollectionMethod string
    Either charge_automatically, or send_invoice. When charging automatically, Stripe will attempt to pay this subscription at the end of the cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as active.
    Created double
    Time at which the object was created. Measured in seconds since the Unix epoch.
    Currency string
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    Customer string
    ID of the customer who owns the subscription.
    CustomerAccount string
    ID of the account representing the customer who owns the subscription.
    DaysUntilDue double
    Number of days a customer has to pay invoices generated by this subscription. This value will be null for subscriptions where collection_method=charge_automatically.
    DefaultPaymentMethod string
    ID of the default payment method for the subscription. It must belong to the customer associated with the subscription. This takes precedence over default_source. If neither are set, invoices will use the customer's invoice_settings.default_payment_method or default_source.
    DefaultSource string
    ID of the default payment source for the subscription. It must belong to the customer associated with the subscription and be in a chargeable state. If default_payment_method is also set, default_payment_method will take precedence. If neither are set, invoices will use the customer's invoice_settings.default_payment_method or default_source.
    DefaultTaxRates List<string>
    The tax rates that will apply to any subscription item that does not have tax_rates set. Invoices created will have their default_tax_rates populated from the subscription.
    Description string
    The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.
    Discounts List<SubscriptionDiscount>
    The discounts applied to the subscription. Subscription item discounts are applied before subscription discounts. Use expand[]=discounts to expand each discount.
    EndedAt double
    If the subscription has ended, the date the subscription ended.
    InvoiceSettings SubscriptionInvoiceSettings
    Items List<SubscriptionItem>
    List of subscription items, each with an attached price.
    Livemode bool
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    ManagedPayments SubscriptionManagedPayments
    Settings for Managed Payments for this Subscription and resulting Invoices and PaymentIntents.
    Metadata Dictionary<string, string>
    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
    NextPendingInvoiceItemInvoice double
    Specifies the approximate timestamp on which any pending invoice items will be billed according to the schedule provided at pending_invoice_item_interval.
    Object string
    String representing the object's type. Objects of the same type share the same value.
    OffSession bool
    Indicates if a customer is on or off-session while an invoice payment is attempted. Defaults to false (on-session).
    OnBehalfOf string
    The account (if any) the charge was made on behalf of for charges associated with this subscription. See the Connect documentation for details.
    PauseCollection SubscriptionPauseCollection
    If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to paused. Learn more about pausing collection.
    PaymentBehavior string
    Controls how Stripe handles the first invoice when payment is required and collection_method=charge_automatically. Subscriptions with collection_method=send_invoice are automatically activated regardless of the first Invoice status.
    PaymentSettings SubscriptionPaymentSettings
    Payment settings passed on to invoices created by the subscription.
    PendingInvoiceItemInterval SubscriptionPendingInvoiceItemInterval
    Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling Create an invoice for the given subscription at the specified interval.
    PendingSetupIntent string
    You can use this SetupIntent to collect user authentication when creating a subscription without immediate payment or updating a subscription's payment method, allowing you to optimize for off-session payments. Learn more in the SCA Migration Guide.
    PendingUpdate SubscriptionPendingUpdate
    If specified, pending updates that will be applied to the subscription once the latest_invoice has been paid.
    PresentmentDetails SubscriptionPresentmentDetails
    ProrationBehavior string
    Determines how to handle prorations resulting from the billing_cycle_anchor. If no value is passed, the default is create_prorations.
    Schedule string
    The schedule attached to the subscription
    StartDate double
    Date when the subscription was first created. The date might differ from the created date due to backdating.
    Status string

    Possible values are incomplete, incomplete_expired, trialing, active, past_due, canceled, unpaid, or paused.

    For collection_method=charge_automatically a subscription moves into incomplete if the initial payment attempt fails. A subscription in this status can only have metadata and default_source updated. Once the first invoice is paid, the subscription moves into an active status. If the first invoice is not paid within 23 hours, the subscription transitions to incomplete_expired. This is a terminal status, the open invoice will be voided and no further invoices will be generated.

    A subscription that is currently in a trial period is trialing and moves to active when the trial period is over.

    A subscription can only enter a paused status when a trial ends without a payment method. A paused subscription doesn't generate invoices and can be resumed after your customer adds their payment method. The paused status is different from pausing collection, which still generates invoices and leaves the subscription's status unchanged.

    If subscription collection_method=charge_automatically, it becomes past_due when payment is required but cannot be paid (due to failed payment or awaiting additional user actions). Once Stripe has exhausted all payment retry attempts, the subscription will become canceled or unpaid (depending on your subscriptions settings).

    If subscription collection_method=send_invoice it becomes past_due when its invoice is not paid by the due date, and canceled or unpaid if it is still not paid by an additional deadline after that. Note that when a subscription has a status of unpaid, no subsequent invoices will be attempted (invoices will be created, but then immediately automatically closed). After receiving updated payment information from a customer, you may choose to reopen and pay their closed invoices.

    TestClock string
    ID of the test clock this subscription belongs to.
    TransferData SubscriptionTransferData
    The account (if any) the subscription's payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the subscription's invoices.
    TrialEnd double
    If the subscription has a trial, the end of that trial.
    TrialFromPlan bool
    Indicates if a plan's trial_period_days should be applied to the subscription. Setting trial_end per subscription is preferred, and this defaults to false. Setting this flag to true together with trial_end is not allowed. See Using trial periods on subscriptions to learn more.
    TrialPeriodDays double
    Integer representing the number of trial period days before the customer is charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. See Using trial periods on subscriptions to learn more.
    TrialSettings SubscriptionTrialSettings
    Settings related to subscription trials.
    TrialStart double
    If the subscription has a trial, the beginning of that trial.
    AddInvoiceItems []SubscriptionAddInvoiceItemArgs
    A list of prices and quantities that will generate invoice items appended to the next invoice for this subscription. You may pass up to 20 items.
    Application string
    ID of the Connect Application that created the subscription.
    ApplicationFeePercent float64
    A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account.
    AutomaticTax SubscriptionAutomaticTaxArgs
    BackdateStartDate float64
    A past timestamp to backdate the subscription's start date to. If set, the first invoice will contain line items for the timespan between the start date and the current time. Can be combined with trials and the billing cycle anchor.
    BillingCycleAnchor float64
    The reference point that aligns future billing cycle dates. It sets the day of week for week intervals, the day of month for month and year intervals, and the month of year for year intervals. The timestamp is in UTC format.
    BillingCycleAnchorConfig SubscriptionBillingCycleAnchorConfigArgs
    The fixed values used to calculate the billing_cycle_anchor.
    BillingMode SubscriptionBillingModeArgs
    The billing mode of the subscription.
    BillingSchedules []SubscriptionBillingScheduleArgs
    Billing schedules for this subscription.
    BillingThresholds SubscriptionBillingThresholdsArgs
    Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period
    CancelAt float64
    A date in the future at which the subscription will automatically get canceled
    CancelAtPeriodEnd bool
    Whether this subscription will (if status=active) or did (if status=canceled) cancel at the end of the current billing period.
    CanceledAt float64
    If the subscription has been canceled, the date of that cancellation. If the subscription was canceled with cancel_at_period_end, canceled_at will reflect the time of the most recent update request, not the end of the subscription period when the subscription is automatically moved to a canceled state.
    CancellationDetails SubscriptionCancellationDetailsArgs
    Details about why this subscription was cancelled
    CollectionMethod string
    Either charge_automatically, or send_invoice. When charging automatically, Stripe will attempt to pay this subscription at the end of the cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as active.
    Created float64
    Time at which the object was created. Measured in seconds since the Unix epoch.
    Currency string
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    Customer string
    ID of the customer who owns the subscription.
    CustomerAccount string
    ID of the account representing the customer who owns the subscription.
    DaysUntilDue float64
    Number of days a customer has to pay invoices generated by this subscription. This value will be null for subscriptions where collection_method=charge_automatically.
    DefaultPaymentMethod string
    ID of the default payment method for the subscription. It must belong to the customer associated with the subscription. This takes precedence over default_source. If neither are set, invoices will use the customer's invoice_settings.default_payment_method or default_source.
    DefaultSource string
    ID of the default payment source for the subscription. It must belong to the customer associated with the subscription and be in a chargeable state. If default_payment_method is also set, default_payment_method will take precedence. If neither are set, invoices will use the customer's invoice_settings.default_payment_method or default_source.
    DefaultTaxRates []string
    The tax rates that will apply to any subscription item that does not have tax_rates set. Invoices created will have their default_tax_rates populated from the subscription.
    Description string
    The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.
    Discounts []SubscriptionDiscountArgs
    The discounts applied to the subscription. Subscription item discounts are applied before subscription discounts. Use expand[]=discounts to expand each discount.
    EndedAt float64
    If the subscription has ended, the date the subscription ended.
    InvoiceSettings SubscriptionInvoiceSettingsArgs
    Items []SubscriptionItemTypeArgs
    List of subscription items, each with an attached price.
    Livemode bool
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    ManagedPayments SubscriptionManagedPaymentsArgs
    Settings for Managed Payments for this Subscription and resulting Invoices and PaymentIntents.
    Metadata map[string]string
    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
    NextPendingInvoiceItemInvoice float64
    Specifies the approximate timestamp on which any pending invoice items will be billed according to the schedule provided at pending_invoice_item_interval.
    Object string
    String representing the object's type. Objects of the same type share the same value.
    OffSession bool
    Indicates if a customer is on or off-session while an invoice payment is attempted. Defaults to false (on-session).
    OnBehalfOf string
    The account (if any) the charge was made on behalf of for charges associated with this subscription. See the Connect documentation for details.
    PauseCollection SubscriptionPauseCollectionArgs
    If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to paused. Learn more about pausing collection.
    PaymentBehavior string
    Controls how Stripe handles the first invoice when payment is required and collection_method=charge_automatically. Subscriptions with collection_method=send_invoice are automatically activated regardless of the first Invoice status.
    PaymentSettings SubscriptionPaymentSettingsArgs
    Payment settings passed on to invoices created by the subscription.
    PendingInvoiceItemInterval SubscriptionPendingInvoiceItemIntervalArgs
    Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling Create an invoice for the given subscription at the specified interval.
    PendingSetupIntent string
    You can use this SetupIntent to collect user authentication when creating a subscription without immediate payment or updating a subscription's payment method, allowing you to optimize for off-session payments. Learn more in the SCA Migration Guide.
    PendingUpdate SubscriptionPendingUpdateArgs
    If specified, pending updates that will be applied to the subscription once the latest_invoice has been paid.
    PresentmentDetails SubscriptionPresentmentDetailsArgs
    ProrationBehavior string
    Determines how to handle prorations resulting from the billing_cycle_anchor. If no value is passed, the default is create_prorations.
    Schedule string
    The schedule attached to the subscription
    StartDate float64
    Date when the subscription was first created. The date might differ from the created date due to backdating.
    Status string

    Possible values are incomplete, incomplete_expired, trialing, active, past_due, canceled, unpaid, or paused.

    For collection_method=charge_automatically a subscription moves into incomplete if the initial payment attempt fails. A subscription in this status can only have metadata and default_source updated. Once the first invoice is paid, the subscription moves into an active status. If the first invoice is not paid within 23 hours, the subscription transitions to incomplete_expired. This is a terminal status, the open invoice will be voided and no further invoices will be generated.

    A subscription that is currently in a trial period is trialing and moves to active when the trial period is over.

    A subscription can only enter a paused status when a trial ends without a payment method. A paused subscription doesn't generate invoices and can be resumed after your customer adds their payment method. The paused status is different from pausing collection, which still generates invoices and leaves the subscription's status unchanged.

    If subscription collection_method=charge_automatically, it becomes past_due when payment is required but cannot be paid (due to failed payment or awaiting additional user actions). Once Stripe has exhausted all payment retry attempts, the subscription will become canceled or unpaid (depending on your subscriptions settings).

    If subscription collection_method=send_invoice it becomes past_due when its invoice is not paid by the due date, and canceled or unpaid if it is still not paid by an additional deadline after that. Note that when a subscription has a status of unpaid, no subsequent invoices will be attempted (invoices will be created, but then immediately automatically closed). After receiving updated payment information from a customer, you may choose to reopen and pay their closed invoices.

    TestClock string
    ID of the test clock this subscription belongs to.
    TransferData SubscriptionTransferDataArgs
    The account (if any) the subscription's payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the subscription's invoices.
    TrialEnd float64
    If the subscription has a trial, the end of that trial.
    TrialFromPlan bool
    Indicates if a plan's trial_period_days should be applied to the subscription. Setting trial_end per subscription is preferred, and this defaults to false. Setting this flag to true together with trial_end is not allowed. See Using trial periods on subscriptions to learn more.
    TrialPeriodDays float64
    Integer representing the number of trial period days before the customer is charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. See Using trial periods on subscriptions to learn more.
    TrialSettings SubscriptionTrialSettingsArgs
    Settings related to subscription trials.
    TrialStart float64
    If the subscription has a trial, the beginning of that trial.
    add_invoice_items list(object)
    A list of prices and quantities that will generate invoice items appended to the next invoice for this subscription. You may pass up to 20 items.
    application string
    ID of the Connect Application that created the subscription.
    application_fee_percent number
    A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account.
    automatic_tax object
    backdate_start_date number
    A past timestamp to backdate the subscription's start date to. If set, the first invoice will contain line items for the timespan between the start date and the current time. Can be combined with trials and the billing cycle anchor.
    billing_cycle_anchor number
    The reference point that aligns future billing cycle dates. It sets the day of week for week intervals, the day of month for month and year intervals, and the month of year for year intervals. The timestamp is in UTC format.
    billing_cycle_anchor_config object
    The fixed values used to calculate the billing_cycle_anchor.
    billing_mode object
    The billing mode of the subscription.
    billing_schedules list(object)
    Billing schedules for this subscription.
    billing_thresholds object
    Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period
    cancel_at number
    A date in the future at which the subscription will automatically get canceled
    cancel_at_period_end bool
    Whether this subscription will (if status=active) or did (if status=canceled) cancel at the end of the current billing period.
    canceled_at number
    If the subscription has been canceled, the date of that cancellation. If the subscription was canceled with cancel_at_period_end, canceled_at will reflect the time of the most recent update request, not the end of the subscription period when the subscription is automatically moved to a canceled state.
    cancellation_details object
    Details about why this subscription was cancelled
    collection_method string
    Either charge_automatically, or send_invoice. When charging automatically, Stripe will attempt to pay this subscription at the end of the cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as active.
    created number
    Time at which the object was created. Measured in seconds since the Unix epoch.
    currency string
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    customer string
    ID of the customer who owns the subscription.
    customer_account string
    ID of the account representing the customer who owns the subscription.
    days_until_due number
    Number of days a customer has to pay invoices generated by this subscription. This value will be null for subscriptions where collection_method=charge_automatically.
    default_payment_method string
    ID of the default payment method for the subscription. It must belong to the customer associated with the subscription. This takes precedence over default_source. If neither are set, invoices will use the customer's invoice_settings.default_payment_method or default_source.
    default_source string
    ID of the default payment source for the subscription. It must belong to the customer associated with the subscription and be in a chargeable state. If default_payment_method is also set, default_payment_method will take precedence. If neither are set, invoices will use the customer's invoice_settings.default_payment_method or default_source.
    default_tax_rates list(string)
    The tax rates that will apply to any subscription item that does not have tax_rates set. Invoices created will have their default_tax_rates populated from the subscription.
    description string
    The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.
    discounts list(object)
    The discounts applied to the subscription. Subscription item discounts are applied before subscription discounts. Use expand[]=discounts to expand each discount.
    ended_at number
    If the subscription has ended, the date the subscription ended.
    invoice_settings object
    items list(object)
    List of subscription items, each with an attached price.
    livemode bool
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    managed_payments object
    Settings for Managed Payments for this Subscription and resulting Invoices and PaymentIntents.
    metadata map(string)
    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
    next_pending_invoice_item_invoice number
    Specifies the approximate timestamp on which any pending invoice items will be billed according to the schedule provided at pending_invoice_item_interval.
    object string
    String representing the object's type. Objects of the same type share the same value.
    off_session bool
    Indicates if a customer is on or off-session while an invoice payment is attempted. Defaults to false (on-session).
    on_behalf_of string
    The account (if any) the charge was made on behalf of for charges associated with this subscription. See the Connect documentation for details.
    pause_collection object
    If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to paused. Learn more about pausing collection.
    payment_behavior string
    Controls how Stripe handles the first invoice when payment is required and collection_method=charge_automatically. Subscriptions with collection_method=send_invoice are automatically activated regardless of the first Invoice status.
    payment_settings object
    Payment settings passed on to invoices created by the subscription.
    pending_invoice_item_interval object
    Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling Create an invoice for the given subscription at the specified interval.
    pending_setup_intent string
    You can use this SetupIntent to collect user authentication when creating a subscription without immediate payment or updating a subscription's payment method, allowing you to optimize for off-session payments. Learn more in the SCA Migration Guide.
    pending_update object
    If specified, pending updates that will be applied to the subscription once the latest_invoice has been paid.
    presentment_details object
    proration_behavior string
    Determines how to handle prorations resulting from the billing_cycle_anchor. If no value is passed, the default is create_prorations.
    schedule string
    The schedule attached to the subscription
    start_date number
    Date when the subscription was first created. The date might differ from the created date due to backdating.
    status string

    Possible values are incomplete, incomplete_expired, trialing, active, past_due, canceled, unpaid, or paused.

    For collection_method=charge_automatically a subscription moves into incomplete if the initial payment attempt fails. A subscription in this status can only have metadata and default_source updated. Once the first invoice is paid, the subscription moves into an active status. If the first invoice is not paid within 23 hours, the subscription transitions to incomplete_expired. This is a terminal status, the open invoice will be voided and no further invoices will be generated.

    A subscription that is currently in a trial period is trialing and moves to active when the trial period is over.

    A subscription can only enter a paused status when a trial ends without a payment method. A paused subscription doesn't generate invoices and can be resumed after your customer adds their payment method. The paused status is different from pausing collection, which still generates invoices and leaves the subscription's status unchanged.

    If subscription collection_method=charge_automatically, it becomes past_due when payment is required but cannot be paid (due to failed payment or awaiting additional user actions). Once Stripe has exhausted all payment retry attempts, the subscription will become canceled or unpaid (depending on your subscriptions settings).

    If subscription collection_method=send_invoice it becomes past_due when its invoice is not paid by the due date, and canceled or unpaid if it is still not paid by an additional deadline after that. Note that when a subscription has a status of unpaid, no subsequent invoices will be attempted (invoices will be created, but then immediately automatically closed). After receiving updated payment information from a customer, you may choose to reopen and pay their closed invoices.

    test_clock string
    ID of the test clock this subscription belongs to.
    transfer_data object
    The account (if any) the subscription's payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the subscription's invoices.
    trial_end number
    If the subscription has a trial, the end of that trial.
    trial_from_plan bool
    Indicates if a plan's trial_period_days should be applied to the subscription. Setting trial_end per subscription is preferred, and this defaults to false. Setting this flag to true together with trial_end is not allowed. See Using trial periods on subscriptions to learn more.
    trial_period_days number
    Integer representing the number of trial period days before the customer is charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. See Using trial periods on subscriptions to learn more.
    trial_settings object
    Settings related to subscription trials.
    trial_start number
    If the subscription has a trial, the beginning of that trial.
    addInvoiceItems List<SubscriptionAddInvoiceItem>
    A list of prices and quantities that will generate invoice items appended to the next invoice for this subscription. You may pass up to 20 items.
    application String
    ID of the Connect Application that created the subscription.
    applicationFeePercent Double
    A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account.
    automaticTax SubscriptionAutomaticTax
    backdateStartDate Double
    A past timestamp to backdate the subscription's start date to. If set, the first invoice will contain line items for the timespan between the start date and the current time. Can be combined with trials and the billing cycle anchor.
    billingCycleAnchor Double
    The reference point that aligns future billing cycle dates. It sets the day of week for week intervals, the day of month for month and year intervals, and the month of year for year intervals. The timestamp is in UTC format.
    billingCycleAnchorConfig SubscriptionBillingCycleAnchorConfig
    The fixed values used to calculate the billing_cycle_anchor.
    billingMode SubscriptionBillingMode
    The billing mode of the subscription.
    billingSchedules List<SubscriptionBillingSchedule>
    Billing schedules for this subscription.
    billingThresholds SubscriptionBillingThresholds
    Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period
    cancelAt Double
    A date in the future at which the subscription will automatically get canceled
    cancelAtPeriodEnd Boolean
    Whether this subscription will (if status=active) or did (if status=canceled) cancel at the end of the current billing period.
    canceledAt Double
    If the subscription has been canceled, the date of that cancellation. If the subscription was canceled with cancel_at_period_end, canceled_at will reflect the time of the most recent update request, not the end of the subscription period when the subscription is automatically moved to a canceled state.
    cancellationDetails SubscriptionCancellationDetails
    Details about why this subscription was cancelled
    collectionMethod String
    Either charge_automatically, or send_invoice. When charging automatically, Stripe will attempt to pay this subscription at the end of the cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as active.
    created Double
    Time at which the object was created. Measured in seconds since the Unix epoch.
    currency String
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    customer String
    ID of the customer who owns the subscription.
    customerAccount String
    ID of the account representing the customer who owns the subscription.
    daysUntilDue Double
    Number of days a customer has to pay invoices generated by this subscription. This value will be null for subscriptions where collection_method=charge_automatically.
    defaultPaymentMethod String
    ID of the default payment method for the subscription. It must belong to the customer associated with the subscription. This takes precedence over default_source. If neither are set, invoices will use the customer's invoice_settings.default_payment_method or default_source.
    defaultSource String
    ID of the default payment source for the subscription. It must belong to the customer associated with the subscription and be in a chargeable state. If default_payment_method is also set, default_payment_method will take precedence. If neither are set, invoices will use the customer's invoice_settings.default_payment_method or default_source.
    defaultTaxRates List<String>
    The tax rates that will apply to any subscription item that does not have tax_rates set. Invoices created will have their default_tax_rates populated from the subscription.
    description String
    The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.
    discounts List<SubscriptionDiscount>
    The discounts applied to the subscription. Subscription item discounts are applied before subscription discounts. Use expand[]=discounts to expand each discount.
    endedAt Double
    If the subscription has ended, the date the subscription ended.
    invoiceSettings SubscriptionInvoiceSettings
    items List<SubscriptionItem>
    List of subscription items, each with an attached price.
    livemode Boolean
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    managedPayments SubscriptionManagedPayments
    Settings for Managed Payments for this Subscription and resulting Invoices and PaymentIntents.
    metadata Map<String,String>
    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
    nextPendingInvoiceItemInvoice Double
    Specifies the approximate timestamp on which any pending invoice items will be billed according to the schedule provided at pending_invoice_item_interval.
    object String
    String representing the object's type. Objects of the same type share the same value.
    offSession Boolean
    Indicates if a customer is on or off-session while an invoice payment is attempted. Defaults to false (on-session).
    onBehalfOf String
    The account (if any) the charge was made on behalf of for charges associated with this subscription. See the Connect documentation for details.
    pauseCollection SubscriptionPauseCollection
    If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to paused. Learn more about pausing collection.
    paymentBehavior String
    Controls how Stripe handles the first invoice when payment is required and collection_method=charge_automatically. Subscriptions with collection_method=send_invoice are automatically activated regardless of the first Invoice status.
    paymentSettings SubscriptionPaymentSettings
    Payment settings passed on to invoices created by the subscription.
    pendingInvoiceItemInterval SubscriptionPendingInvoiceItemInterval
    Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling Create an invoice for the given subscription at the specified interval.
    pendingSetupIntent String
    You can use this SetupIntent to collect user authentication when creating a subscription without immediate payment or updating a subscription's payment method, allowing you to optimize for off-session payments. Learn more in the SCA Migration Guide.
    pendingUpdate SubscriptionPendingUpdate
    If specified, pending updates that will be applied to the subscription once the latest_invoice has been paid.
    presentmentDetails SubscriptionPresentmentDetails
    prorationBehavior String
    Determines how to handle prorations resulting from the billing_cycle_anchor. If no value is passed, the default is create_prorations.
    schedule String
    The schedule attached to the subscription
    startDate Double
    Date when the subscription was first created. The date might differ from the created date due to backdating.
    status String

    Possible values are incomplete, incomplete_expired, trialing, active, past_due, canceled, unpaid, or paused.

    For collection_method=charge_automatically a subscription moves into incomplete if the initial payment attempt fails. A subscription in this status can only have metadata and default_source updated. Once the first invoice is paid, the subscription moves into an active status. If the first invoice is not paid within 23 hours, the subscription transitions to incomplete_expired. This is a terminal status, the open invoice will be voided and no further invoices will be generated.

    A subscription that is currently in a trial period is trialing and moves to active when the trial period is over.

    A subscription can only enter a paused status when a trial ends without a payment method. A paused subscription doesn't generate invoices and can be resumed after your customer adds their payment method. The paused status is different from pausing collection, which still generates invoices and leaves the subscription's status unchanged.

    If subscription collection_method=charge_automatically, it becomes past_due when payment is required but cannot be paid (due to failed payment or awaiting additional user actions). Once Stripe has exhausted all payment retry attempts, the subscription will become canceled or unpaid (depending on your subscriptions settings).

    If subscription collection_method=send_invoice it becomes past_due when its invoice is not paid by the due date, and canceled or unpaid if it is still not paid by an additional deadline after that. Note that when a subscription has a status of unpaid, no subsequent invoices will be attempted (invoices will be created, but then immediately automatically closed). After receiving updated payment information from a customer, you may choose to reopen and pay their closed invoices.

    testClock String
    ID of the test clock this subscription belongs to.
    transferData SubscriptionTransferData
    The account (if any) the subscription's payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the subscription's invoices.
    trialEnd Double
    If the subscription has a trial, the end of that trial.
    trialFromPlan Boolean
    Indicates if a plan's trial_period_days should be applied to the subscription. Setting trial_end per subscription is preferred, and this defaults to false. Setting this flag to true together with trial_end is not allowed. See Using trial periods on subscriptions to learn more.
    trialPeriodDays Double
    Integer representing the number of trial period days before the customer is charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. See Using trial periods on subscriptions to learn more.
    trialSettings SubscriptionTrialSettings
    Settings related to subscription trials.
    trialStart Double
    If the subscription has a trial, the beginning of that trial.
    addInvoiceItems SubscriptionAddInvoiceItem[]
    A list of prices and quantities that will generate invoice items appended to the next invoice for this subscription. You may pass up to 20 items.
    application string
    ID of the Connect Application that created the subscription.
    applicationFeePercent number
    A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account.
    automaticTax SubscriptionAutomaticTax
    backdateStartDate number
    A past timestamp to backdate the subscription's start date to. If set, the first invoice will contain line items for the timespan between the start date and the current time. Can be combined with trials and the billing cycle anchor.
    billingCycleAnchor number
    The reference point that aligns future billing cycle dates. It sets the day of week for week intervals, the day of month for month and year intervals, and the month of year for year intervals. The timestamp is in UTC format.
    billingCycleAnchorConfig SubscriptionBillingCycleAnchorConfig
    The fixed values used to calculate the billing_cycle_anchor.
    billingMode SubscriptionBillingMode
    The billing mode of the subscription.
    billingSchedules SubscriptionBillingSchedule[]
    Billing schedules for this subscription.
    billingThresholds SubscriptionBillingThresholds
    Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period
    cancelAt number
    A date in the future at which the subscription will automatically get canceled
    cancelAtPeriodEnd boolean
    Whether this subscription will (if status=active) or did (if status=canceled) cancel at the end of the current billing period.
    canceledAt number
    If the subscription has been canceled, the date of that cancellation. If the subscription was canceled with cancel_at_period_end, canceled_at will reflect the time of the most recent update request, not the end of the subscription period when the subscription is automatically moved to a canceled state.
    cancellationDetails SubscriptionCancellationDetails
    Details about why this subscription was cancelled
    collectionMethod string
    Either charge_automatically, or send_invoice. When charging automatically, Stripe will attempt to pay this subscription at the end of the cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as active.
    created number
    Time at which the object was created. Measured in seconds since the Unix epoch.
    currency string
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    customer string
    ID of the customer who owns the subscription.
    customerAccount string
    ID of the account representing the customer who owns the subscription.
    daysUntilDue number
    Number of days a customer has to pay invoices generated by this subscription. This value will be null for subscriptions where collection_method=charge_automatically.
    defaultPaymentMethod string
    ID of the default payment method for the subscription. It must belong to the customer associated with the subscription. This takes precedence over default_source. If neither are set, invoices will use the customer's invoice_settings.default_payment_method or default_source.
    defaultSource string
    ID of the default payment source for the subscription. It must belong to the customer associated with the subscription and be in a chargeable state. If default_payment_method is also set, default_payment_method will take precedence. If neither are set, invoices will use the customer's invoice_settings.default_payment_method or default_source.
    defaultTaxRates string[]
    The tax rates that will apply to any subscription item that does not have tax_rates set. Invoices created will have their default_tax_rates populated from the subscription.
    description string
    The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.
    discounts SubscriptionDiscount[]
    The discounts applied to the subscription. Subscription item discounts are applied before subscription discounts. Use expand[]=discounts to expand each discount.
    endedAt number
    If the subscription has ended, the date the subscription ended.
    invoiceSettings SubscriptionInvoiceSettings
    items SubscriptionItem[]
    List of subscription items, each with an attached price.
    livemode boolean
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    managedPayments SubscriptionManagedPayments
    Settings for Managed Payments for this Subscription and resulting Invoices and PaymentIntents.
    metadata {[key: string]: string}
    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
    nextPendingInvoiceItemInvoice number
    Specifies the approximate timestamp on which any pending invoice items will be billed according to the schedule provided at pending_invoice_item_interval.
    object string
    String representing the object's type. Objects of the same type share the same value.
    offSession boolean
    Indicates if a customer is on or off-session while an invoice payment is attempted. Defaults to false (on-session).
    onBehalfOf string
    The account (if any) the charge was made on behalf of for charges associated with this subscription. See the Connect documentation for details.
    pauseCollection SubscriptionPauseCollection
    If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to paused. Learn more about pausing collection.
    paymentBehavior string
    Controls how Stripe handles the first invoice when payment is required and collection_method=charge_automatically. Subscriptions with collection_method=send_invoice are automatically activated regardless of the first Invoice status.
    paymentSettings SubscriptionPaymentSettings
    Payment settings passed on to invoices created by the subscription.
    pendingInvoiceItemInterval SubscriptionPendingInvoiceItemInterval
    Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling Create an invoice for the given subscription at the specified interval.
    pendingSetupIntent string
    You can use this SetupIntent to collect user authentication when creating a subscription without immediate payment or updating a subscription's payment method, allowing you to optimize for off-session payments. Learn more in the SCA Migration Guide.
    pendingUpdate SubscriptionPendingUpdate
    If specified, pending updates that will be applied to the subscription once the latest_invoice has been paid.
    presentmentDetails SubscriptionPresentmentDetails
    prorationBehavior string
    Determines how to handle prorations resulting from the billing_cycle_anchor. If no value is passed, the default is create_prorations.
    schedule string
    The schedule attached to the subscription
    startDate number
    Date when the subscription was first created. The date might differ from the created date due to backdating.
    status string

    Possible values are incomplete, incomplete_expired, trialing, active, past_due, canceled, unpaid, or paused.

    For collection_method=charge_automatically a subscription moves into incomplete if the initial payment attempt fails. A subscription in this status can only have metadata and default_source updated. Once the first invoice is paid, the subscription moves into an active status. If the first invoice is not paid within 23 hours, the subscription transitions to incomplete_expired. This is a terminal status, the open invoice will be voided and no further invoices will be generated.

    A subscription that is currently in a trial period is trialing and moves to active when the trial period is over.

    A subscription can only enter a paused status when a trial ends without a payment method. A paused subscription doesn't generate invoices and can be resumed after your customer adds their payment method. The paused status is different from pausing collection, which still generates invoices and leaves the subscription's status unchanged.

    If subscription collection_method=charge_automatically, it becomes past_due when payment is required but cannot be paid (due to failed payment or awaiting additional user actions). Once Stripe has exhausted all payment retry attempts, the subscription will become canceled or unpaid (depending on your subscriptions settings).

    If subscription collection_method=send_invoice it becomes past_due when its invoice is not paid by the due date, and canceled or unpaid if it is still not paid by an additional deadline after that. Note that when a subscription has a status of unpaid, no subsequent invoices will be attempted (invoices will be created, but then immediately automatically closed). After receiving updated payment information from a customer, you may choose to reopen and pay their closed invoices.

    testClock string
    ID of the test clock this subscription belongs to.
    transferData SubscriptionTransferData
    The account (if any) the subscription's payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the subscription's invoices.
    trialEnd number
    If the subscription has a trial, the end of that trial.
    trialFromPlan boolean
    Indicates if a plan's trial_period_days should be applied to the subscription. Setting trial_end per subscription is preferred, and this defaults to false. Setting this flag to true together with trial_end is not allowed. See Using trial periods on subscriptions to learn more.
    trialPeriodDays number
    Integer representing the number of trial period days before the customer is charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. See Using trial periods on subscriptions to learn more.
    trialSettings SubscriptionTrialSettings
    Settings related to subscription trials.
    trialStart number
    If the subscription has a trial, the beginning of that trial.
    add_invoice_items Sequence[SubscriptionAddInvoiceItemArgs]
    A list of prices and quantities that will generate invoice items appended to the next invoice for this subscription. You may pass up to 20 items.
    application str
    ID of the Connect Application that created the subscription.
    application_fee_percent float
    A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account.
    automatic_tax SubscriptionAutomaticTaxArgs
    backdate_start_date float
    A past timestamp to backdate the subscription's start date to. If set, the first invoice will contain line items for the timespan between the start date and the current time. Can be combined with trials and the billing cycle anchor.
    billing_cycle_anchor float
    The reference point that aligns future billing cycle dates. It sets the day of week for week intervals, the day of month for month and year intervals, and the month of year for year intervals. The timestamp is in UTC format.
    billing_cycle_anchor_config SubscriptionBillingCycleAnchorConfigArgs
    The fixed values used to calculate the billing_cycle_anchor.
    billing_mode SubscriptionBillingModeArgs
    The billing mode of the subscription.
    billing_schedules Sequence[SubscriptionBillingScheduleArgs]
    Billing schedules for this subscription.
    billing_thresholds SubscriptionBillingThresholdsArgs
    Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period
    cancel_at float
    A date in the future at which the subscription will automatically get canceled
    cancel_at_period_end bool
    Whether this subscription will (if status=active) or did (if status=canceled) cancel at the end of the current billing period.
    canceled_at float
    If the subscription has been canceled, the date of that cancellation. If the subscription was canceled with cancel_at_period_end, canceled_at will reflect the time of the most recent update request, not the end of the subscription period when the subscription is automatically moved to a canceled state.
    cancellation_details SubscriptionCancellationDetailsArgs
    Details about why this subscription was cancelled
    collection_method str
    Either charge_automatically, or send_invoice. When charging automatically, Stripe will attempt to pay this subscription at the end of the cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as active.
    created float
    Time at which the object was created. Measured in seconds since the Unix epoch.
    currency str
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    customer str
    ID of the customer who owns the subscription.
    customer_account str
    ID of the account representing the customer who owns the subscription.
    days_until_due float
    Number of days a customer has to pay invoices generated by this subscription. This value will be null for subscriptions where collection_method=charge_automatically.
    default_payment_method str
    ID of the default payment method for the subscription. It must belong to the customer associated with the subscription. This takes precedence over default_source. If neither are set, invoices will use the customer's invoice_settings.default_payment_method or default_source.
    default_source str
    ID of the default payment source for the subscription. It must belong to the customer associated with the subscription and be in a chargeable state. If default_payment_method is also set, default_payment_method will take precedence. If neither are set, invoices will use the customer's invoice_settings.default_payment_method or default_source.
    default_tax_rates Sequence[str]
    The tax rates that will apply to any subscription item that does not have tax_rates set. Invoices created will have their default_tax_rates populated from the subscription.
    description str
    The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.
    discounts Sequence[SubscriptionDiscountArgs]
    The discounts applied to the subscription. Subscription item discounts are applied before subscription discounts. Use expand[]=discounts to expand each discount.
    ended_at float
    If the subscription has ended, the date the subscription ended.
    invoice_settings SubscriptionInvoiceSettingsArgs
    items Sequence[SubscriptionItemArgs]
    List of subscription items, each with an attached price.
    livemode bool
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    managed_payments SubscriptionManagedPaymentsArgs
    Settings for Managed Payments for this Subscription and resulting Invoices and PaymentIntents.
    metadata Mapping[str, str]
    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
    next_pending_invoice_item_invoice float
    Specifies the approximate timestamp on which any pending invoice items will be billed according to the schedule provided at pending_invoice_item_interval.
    object str
    String representing the object's type. Objects of the same type share the same value.
    off_session bool
    Indicates if a customer is on or off-session while an invoice payment is attempted. Defaults to false (on-session).
    on_behalf_of str
    The account (if any) the charge was made on behalf of for charges associated with this subscription. See the Connect documentation for details.
    pause_collection SubscriptionPauseCollectionArgs
    If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to paused. Learn more about pausing collection.
    payment_behavior str
    Controls how Stripe handles the first invoice when payment is required and collection_method=charge_automatically. Subscriptions with collection_method=send_invoice are automatically activated regardless of the first Invoice status.
    payment_settings SubscriptionPaymentSettingsArgs
    Payment settings passed on to invoices created by the subscription.
    pending_invoice_item_interval SubscriptionPendingInvoiceItemIntervalArgs
    Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling Create an invoice for the given subscription at the specified interval.
    pending_setup_intent str
    You can use this SetupIntent to collect user authentication when creating a subscription without immediate payment or updating a subscription's payment method, allowing you to optimize for off-session payments. Learn more in the SCA Migration Guide.
    pending_update SubscriptionPendingUpdateArgs
    If specified, pending updates that will be applied to the subscription once the latest_invoice has been paid.
    presentment_details SubscriptionPresentmentDetailsArgs
    proration_behavior str
    Determines how to handle prorations resulting from the billing_cycle_anchor. If no value is passed, the default is create_prorations.
    schedule str
    The schedule attached to the subscription
    start_date float
    Date when the subscription was first created. The date might differ from the created date due to backdating.
    status str

    Possible values are incomplete, incomplete_expired, trialing, active, past_due, canceled, unpaid, or paused.

    For collection_method=charge_automatically a subscription moves into incomplete if the initial payment attempt fails. A subscription in this status can only have metadata and default_source updated. Once the first invoice is paid, the subscription moves into an active status. If the first invoice is not paid within 23 hours, the subscription transitions to incomplete_expired. This is a terminal status, the open invoice will be voided and no further invoices will be generated.

    A subscription that is currently in a trial period is trialing and moves to active when the trial period is over.

    A subscription can only enter a paused status when a trial ends without a payment method. A paused subscription doesn't generate invoices and can be resumed after your customer adds their payment method. The paused status is different from pausing collection, which still generates invoices and leaves the subscription's status unchanged.

    If subscription collection_method=charge_automatically, it becomes past_due when payment is required but cannot be paid (due to failed payment or awaiting additional user actions). Once Stripe has exhausted all payment retry attempts, the subscription will become canceled or unpaid (depending on your subscriptions settings).

    If subscription collection_method=send_invoice it becomes past_due when its invoice is not paid by the due date, and canceled or unpaid if it is still not paid by an additional deadline after that. Note that when a subscription has a status of unpaid, no subsequent invoices will be attempted (invoices will be created, but then immediately automatically closed). After receiving updated payment information from a customer, you may choose to reopen and pay their closed invoices.

    test_clock str
    ID of the test clock this subscription belongs to.
    transfer_data SubscriptionTransferDataArgs
    The account (if any) the subscription's payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the subscription's invoices.
    trial_end float
    If the subscription has a trial, the end of that trial.
    trial_from_plan bool
    Indicates if a plan's trial_period_days should be applied to the subscription. Setting trial_end per subscription is preferred, and this defaults to false. Setting this flag to true together with trial_end is not allowed. See Using trial periods on subscriptions to learn more.
    trial_period_days float
    Integer representing the number of trial period days before the customer is charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. See Using trial periods on subscriptions to learn more.
    trial_settings SubscriptionTrialSettingsArgs
    Settings related to subscription trials.
    trial_start float
    If the subscription has a trial, the beginning of that trial.
    addInvoiceItems List<Property Map>
    A list of prices and quantities that will generate invoice items appended to the next invoice for this subscription. You may pass up to 20 items.
    application String
    ID of the Connect Application that created the subscription.
    applicationFeePercent Number
    A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account.
    automaticTax Property Map
    backdateStartDate Number
    A past timestamp to backdate the subscription's start date to. If set, the first invoice will contain line items for the timespan between the start date and the current time. Can be combined with trials and the billing cycle anchor.
    billingCycleAnchor Number
    The reference point that aligns future billing cycle dates. It sets the day of week for week intervals, the day of month for month and year intervals, and the month of year for year intervals. The timestamp is in UTC format.
    billingCycleAnchorConfig Property Map
    The fixed values used to calculate the billing_cycle_anchor.
    billingMode Property Map
    The billing mode of the subscription.
    billingSchedules List<Property Map>
    Billing schedules for this subscription.
    billingThresholds Property Map
    Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period
    cancelAt Number
    A date in the future at which the subscription will automatically get canceled
    cancelAtPeriodEnd Boolean
    Whether this subscription will (if status=active) or did (if status=canceled) cancel at the end of the current billing period.
    canceledAt Number
    If the subscription has been canceled, the date of that cancellation. If the subscription was canceled with cancel_at_period_end, canceled_at will reflect the time of the most recent update request, not the end of the subscription period when the subscription is automatically moved to a canceled state.
    cancellationDetails Property Map
    Details about why this subscription was cancelled
    collectionMethod String
    Either charge_automatically, or send_invoice. When charging automatically, Stripe will attempt to pay this subscription at the end of the cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as active.
    created Number
    Time at which the object was created. Measured in seconds since the Unix epoch.
    currency String
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    customer String
    ID of the customer who owns the subscription.
    customerAccount String
    ID of the account representing the customer who owns the subscription.
    daysUntilDue Number
    Number of days a customer has to pay invoices generated by this subscription. This value will be null for subscriptions where collection_method=charge_automatically.
    defaultPaymentMethod String
    ID of the default payment method for the subscription. It must belong to the customer associated with the subscription. This takes precedence over default_source. If neither are set, invoices will use the customer's invoice_settings.default_payment_method or default_source.
    defaultSource String
    ID of the default payment source for the subscription. It must belong to the customer associated with the subscription and be in a chargeable state. If default_payment_method is also set, default_payment_method will take precedence. If neither are set, invoices will use the customer's invoice_settings.default_payment_method or default_source.
    defaultTaxRates List<String>
    The tax rates that will apply to any subscription item that does not have tax_rates set. Invoices created will have their default_tax_rates populated from the subscription.
    description String
    The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.
    discounts List<Property Map>
    The discounts applied to the subscription. Subscription item discounts are applied before subscription discounts. Use expand[]=discounts to expand each discount.
    endedAt Number
    If the subscription has ended, the date the subscription ended.
    invoiceSettings Property Map
    items List<Property Map>
    List of subscription items, each with an attached price.
    livemode Boolean
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    managedPayments Property Map
    Settings for Managed Payments for this Subscription and resulting Invoices and PaymentIntents.
    metadata Map<String>
    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
    nextPendingInvoiceItemInvoice Number
    Specifies the approximate timestamp on which any pending invoice items will be billed according to the schedule provided at pending_invoice_item_interval.
    object String
    String representing the object's type. Objects of the same type share the same value.
    offSession Boolean
    Indicates if a customer is on or off-session while an invoice payment is attempted. Defaults to false (on-session).
    onBehalfOf String
    The account (if any) the charge was made on behalf of for charges associated with this subscription. See the Connect documentation for details.
    pauseCollection Property Map
    If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to paused. Learn more about pausing collection.
    paymentBehavior String
    Controls how Stripe handles the first invoice when payment is required and collection_method=charge_automatically. Subscriptions with collection_method=send_invoice are automatically activated regardless of the first Invoice status.
    paymentSettings Property Map
    Payment settings passed on to invoices created by the subscription.
    pendingInvoiceItemInterval Property Map
    Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling Create an invoice for the given subscription at the specified interval.
    pendingSetupIntent String
    You can use this SetupIntent to collect user authentication when creating a subscription without immediate payment or updating a subscription's payment method, allowing you to optimize for off-session payments. Learn more in the SCA Migration Guide.
    pendingUpdate Property Map
    If specified, pending updates that will be applied to the subscription once the latest_invoice has been paid.
    presentmentDetails Property Map
    prorationBehavior String
    Determines how to handle prorations resulting from the billing_cycle_anchor. If no value is passed, the default is create_prorations.
    schedule String
    The schedule attached to the subscription
    startDate Number
    Date when the subscription was first created. The date might differ from the created date due to backdating.
    status String

    Possible values are incomplete, incomplete_expired, trialing, active, past_due, canceled, unpaid, or paused.

    For collection_method=charge_automatically a subscription moves into incomplete if the initial payment attempt fails. A subscription in this status can only have metadata and default_source updated. Once the first invoice is paid, the subscription moves into an active status. If the first invoice is not paid within 23 hours, the subscription transitions to incomplete_expired. This is a terminal status, the open invoice will be voided and no further invoices will be generated.

    A subscription that is currently in a trial period is trialing and moves to active when the trial period is over.

    A subscription can only enter a paused status when a trial ends without a payment method. A paused subscription doesn't generate invoices and can be resumed after your customer adds their payment method. The paused status is different from pausing collection, which still generates invoices and leaves the subscription's status unchanged.

    If subscription collection_method=charge_automatically, it becomes past_due when payment is required but cannot be paid (due to failed payment or awaiting additional user actions). Once Stripe has exhausted all payment retry attempts, the subscription will become canceled or unpaid (depending on your subscriptions settings).

    If subscription collection_method=send_invoice it becomes past_due when its invoice is not paid by the due date, and canceled or unpaid if it is still not paid by an additional deadline after that. Note that when a subscription has a status of unpaid, no subsequent invoices will be attempted (invoices will be created, but then immediately automatically closed). After receiving updated payment information from a customer, you may choose to reopen and pay their closed invoices.

    testClock String
    ID of the test clock this subscription belongs to.
    transferData Property Map
    The account (if any) the subscription's payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the subscription's invoices.
    trialEnd Number
    If the subscription has a trial, the end of that trial.
    trialFromPlan Boolean
    Indicates if a plan's trial_period_days should be applied to the subscription. Setting trial_end per subscription is preferred, and this defaults to false. Setting this flag to true together with trial_end is not allowed. See Using trial periods on subscriptions to learn more.
    trialPeriodDays Number
    Integer representing the number of trial period days before the customer is charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. See Using trial periods on subscriptions to learn more.
    trialSettings Property Map
    Settings related to subscription trials.
    trialStart Number
    If the subscription has a trial, the beginning of that trial.

    Supporting Types

    SubscriptionAddInvoiceItem, SubscriptionAddInvoiceItemArgs

    Discountable bool
    Controls whether discounts apply to this invoice item. Defaults to true if no value is provided.
    Discounts List<SubscriptionAddInvoiceItemDiscount>
    The coupons to redeem into discounts for the item.
    Metadata Dictionary<string, string>
    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.
    Period SubscriptionAddInvoiceItemPeriod
    The period associated with this invoice item. If not set, period.start.type defaults to max_item_period_start and period.end.type defaults to min_item_period_end.
    Price string
    The ID of the price object. One of price or price_data is required.
    PriceData SubscriptionAddInvoiceItemPriceData
    Data used to generate a new Price object inline. One of price or price_data is required.
    Quantity double
    Quantity for this item. Defaults to 1.
    TaxRates List<string>
    The tax rates which apply to the item. When set, the default_tax_rates do not apply to this item.
    Discountable bool
    Controls whether discounts apply to this invoice item. Defaults to true if no value is provided.
    Discounts []SubscriptionAddInvoiceItemDiscount
    The coupons to redeem into discounts for the item.
    Metadata map[string]string
    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.
    Period SubscriptionAddInvoiceItemPeriod
    The period associated with this invoice item. If not set, period.start.type defaults to max_item_period_start and period.end.type defaults to min_item_period_end.
    Price string
    The ID of the price object. One of price or price_data is required.
    PriceData SubscriptionAddInvoiceItemPriceData
    Data used to generate a new Price object inline. One of price or price_data is required.
    Quantity float64
    Quantity for this item. Defaults to 1.
    TaxRates []string
    The tax rates which apply to the item. When set, the default_tax_rates do not apply to this item.
    discountable bool
    Controls whether discounts apply to this invoice item. Defaults to true if no value is provided.
    discounts list(object)
    The coupons to redeem into discounts for the item.
    metadata map(string)
    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.
    period object
    The period associated with this invoice item. If not set, period.start.type defaults to max_item_period_start and period.end.type defaults to min_item_period_end.
    price string
    The ID of the price object. One of price or price_data is required.
    price_data object
    Data used to generate a new Price object inline. One of price or price_data is required.
    quantity number
    Quantity for this item. Defaults to 1.
    tax_rates list(string)
    The tax rates which apply to the item. When set, the default_tax_rates do not apply to this item.
    discountable Boolean
    Controls whether discounts apply to this invoice item. Defaults to true if no value is provided.
    discounts List<SubscriptionAddInvoiceItemDiscount>
    The coupons to redeem into discounts for the item.
    metadata Map<String,String>
    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.
    period SubscriptionAddInvoiceItemPeriod
    The period associated with this invoice item. If not set, period.start.type defaults to max_item_period_start and period.end.type defaults to min_item_period_end.
    price String
    The ID of the price object. One of price or price_data is required.
    priceData SubscriptionAddInvoiceItemPriceData
    Data used to generate a new Price object inline. One of price or price_data is required.
    quantity Double
    Quantity for this item. Defaults to 1.
    taxRates List<String>
    The tax rates which apply to the item. When set, the default_tax_rates do not apply to this item.
    discountable boolean
    Controls whether discounts apply to this invoice item. Defaults to true if no value is provided.
    discounts SubscriptionAddInvoiceItemDiscount[]
    The coupons to redeem into discounts for the item.
    metadata {[key: string]: string}
    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.
    period SubscriptionAddInvoiceItemPeriod
    The period associated with this invoice item. If not set, period.start.type defaults to max_item_period_start and period.end.type defaults to min_item_period_end.
    price string
    The ID of the price object. One of price or price_data is required.
    priceData SubscriptionAddInvoiceItemPriceData
    Data used to generate a new Price object inline. One of price or price_data is required.
    quantity number
    Quantity for this item. Defaults to 1.
    taxRates string[]
    The tax rates which apply to the item. When set, the default_tax_rates do not apply to this item.
    discountable bool
    Controls whether discounts apply to this invoice item. Defaults to true if no value is provided.
    discounts Sequence[SubscriptionAddInvoiceItemDiscount]
    The coupons to redeem into discounts for the item.
    metadata Mapping[str, str]
    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.
    period SubscriptionAddInvoiceItemPeriod
    The period associated with this invoice item. If not set, period.start.type defaults to max_item_period_start and period.end.type defaults to min_item_period_end.
    price str
    The ID of the price object. One of price or price_data is required.
    price_data SubscriptionAddInvoiceItemPriceData
    Data used to generate a new Price object inline. One of price or price_data is required.
    quantity float
    Quantity for this item. Defaults to 1.
    tax_rates Sequence[str]
    The tax rates which apply to the item. When set, the default_tax_rates do not apply to this item.
    discountable Boolean
    Controls whether discounts apply to this invoice item. Defaults to true if no value is provided.
    discounts List<Property Map>
    The coupons to redeem into discounts for the item.
    metadata Map<String>
    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.
    period Property Map
    The period associated with this invoice item. If not set, period.start.type defaults to max_item_period_start and period.end.type defaults to min_item_period_end.
    price String
    The ID of the price object. One of price or price_data is required.
    priceData Property Map
    Data used to generate a new Price object inline. One of price or price_data is required.
    quantity Number
    Quantity for this item. Defaults to 1.
    taxRates List<String>
    The tax rates which apply to the item. When set, the default_tax_rates do not apply to this item.

    SubscriptionAddInvoiceItemDiscount, SubscriptionAddInvoiceItemDiscountArgs

    Coupon string
    ID of the coupon to create a new discount for.
    Discount string
    ID of an existing discount on the object (or one of its ancestors) to reuse.
    PromotionCode string
    ID of the promotion code to create a new discount for.
    Coupon string
    ID of the coupon to create a new discount for.
    Discount string
    ID of an existing discount on the object (or one of its ancestors) to reuse.
    PromotionCode string
    ID of the promotion code to create a new discount for.
    coupon string
    ID of the coupon to create a new discount for.
    discount string
    ID of an existing discount on the object (or one of its ancestors) to reuse.
    promotion_code string
    ID of the promotion code to create a new discount for.
    coupon String
    ID of the coupon to create a new discount for.
    discount String
    ID of an existing discount on the object (or one of its ancestors) to reuse.
    promotionCode String
    ID of the promotion code to create a new discount for.
    coupon string
    ID of the coupon to create a new discount for.
    discount string
    ID of an existing discount on the object (or one of its ancestors) to reuse.
    promotionCode string
    ID of the promotion code to create a new discount for.
    coupon str
    ID of the coupon to create a new discount for.
    discount str
    ID of an existing discount on the object (or one of its ancestors) to reuse.
    promotion_code str
    ID of the promotion code to create a new discount for.
    coupon String
    ID of the coupon to create a new discount for.
    discount String
    ID of an existing discount on the object (or one of its ancestors) to reuse.
    promotionCode String
    ID of the promotion code to create a new discount for.

    SubscriptionAddInvoiceItemPeriod, SubscriptionAddInvoiceItemPeriodArgs

    End SubscriptionAddInvoiceItemPeriodEnd
    End of the invoice item period.
    Start SubscriptionAddInvoiceItemPeriodStart
    Start of the invoice item period.
    End SubscriptionAddInvoiceItemPeriodEnd
    End of the invoice item period.
    Start SubscriptionAddInvoiceItemPeriodStart
    Start of the invoice item period.
    end object
    End of the invoice item period.
    start object
    Start of the invoice item period.
    end SubscriptionAddInvoiceItemPeriodEnd
    End of the invoice item period.
    start SubscriptionAddInvoiceItemPeriodStart
    Start of the invoice item period.
    end SubscriptionAddInvoiceItemPeriodEnd
    End of the invoice item period.
    start SubscriptionAddInvoiceItemPeriodStart
    Start of the invoice item period.
    end SubscriptionAddInvoiceItemPeriodEnd
    End of the invoice item period.
    start SubscriptionAddInvoiceItemPeriodStart
    Start of the invoice item period.
    end Property Map
    End of the invoice item period.
    start Property Map
    Start of the invoice item period.

    SubscriptionAddInvoiceItemPeriodEnd, SubscriptionAddInvoiceItemPeriodEndArgs

    Type string
    Select how to calculate the end of the invoice item period.
    Timestamp double
    A precise Unix timestamp for the end of the invoice item period. Must be greater than or equal to period.start.
    Type string
    Select how to calculate the end of the invoice item period.
    Timestamp float64
    A precise Unix timestamp for the end of the invoice item period. Must be greater than or equal to period.start.
    type string
    Select how to calculate the end of the invoice item period.
    timestamp number
    A precise Unix timestamp for the end of the invoice item period. Must be greater than or equal to period.start.
    type String
    Select how to calculate the end of the invoice item period.
    timestamp Double
    A precise Unix timestamp for the end of the invoice item period. Must be greater than or equal to period.start.
    type string
    Select how to calculate the end of the invoice item period.
    timestamp number
    A precise Unix timestamp for the end of the invoice item period. Must be greater than or equal to period.start.
    type str
    Select how to calculate the end of the invoice item period.
    timestamp float
    A precise Unix timestamp for the end of the invoice item period. Must be greater than or equal to period.start.
    type String
    Select how to calculate the end of the invoice item period.
    timestamp Number
    A precise Unix timestamp for the end of the invoice item period. Must be greater than or equal to period.start.

    SubscriptionAddInvoiceItemPeriodStart, SubscriptionAddInvoiceItemPeriodStartArgs

    Type string
    Select how to calculate the start of the invoice item period.
    Timestamp double
    A precise Unix timestamp for the start of the invoice item period. Must be less than or equal to period.end.
    Type string
    Select how to calculate the start of the invoice item period.
    Timestamp float64
    A precise Unix timestamp for the start of the invoice item period. Must be less than or equal to period.end.
    type string
    Select how to calculate the start of the invoice item period.
    timestamp number
    A precise Unix timestamp for the start of the invoice item period. Must be less than or equal to period.end.
    type String
    Select how to calculate the start of the invoice item period.
    timestamp Double
    A precise Unix timestamp for the start of the invoice item period. Must be less than or equal to period.end.
    type string
    Select how to calculate the start of the invoice item period.
    timestamp number
    A precise Unix timestamp for the start of the invoice item period. Must be less than or equal to period.end.
    type str
    Select how to calculate the start of the invoice item period.
    timestamp float
    A precise Unix timestamp for the start of the invoice item period. Must be less than or equal to period.end.
    type String
    Select how to calculate the start of the invoice item period.
    timestamp Number
    A precise Unix timestamp for the start of the invoice item period. Must be less than or equal to period.end.

    SubscriptionAddInvoiceItemPriceData, SubscriptionAddInvoiceItemPriceDataArgs

    Currency string
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    Product string
    The ID of the Product that this Price will belong to.
    TaxBehavior string
    Only required if a default tax behavior was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of inclusive, exclusive, or unspecified. Once specified as either inclusive or exclusive, it cannot be changed.
    UnitAmount double
    A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge or a negative integer representing the amount to credit to the customer.
    UnitAmountDecimal double
    Same as unit_amount, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of unit_amount and unit_amount_decimal can be set.
    Currency string
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    Product string
    The ID of the Product that this Price will belong to.
    TaxBehavior string
    Only required if a default tax behavior was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of inclusive, exclusive, or unspecified. Once specified as either inclusive or exclusive, it cannot be changed.
    UnitAmount float64
    A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge or a negative integer representing the amount to credit to the customer.
    UnitAmountDecimal float64
    Same as unit_amount, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of unit_amount and unit_amount_decimal can be set.
    currency string
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    product string
    The ID of the Product that this Price will belong to.
    tax_behavior string
    Only required if a default tax behavior was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of inclusive, exclusive, or unspecified. Once specified as either inclusive or exclusive, it cannot be changed.
    unit_amount number
    A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge or a negative integer representing the amount to credit to the customer.
    unit_amount_decimal number
    Same as unit_amount, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of unit_amount and unit_amount_decimal can be set.
    currency String
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    product String
    The ID of the Product that this Price will belong to.
    taxBehavior String
    Only required if a default tax behavior was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of inclusive, exclusive, or unspecified. Once specified as either inclusive or exclusive, it cannot be changed.
    unitAmount Double
    A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge or a negative integer representing the amount to credit to the customer.
    unitAmountDecimal Double
    Same as unit_amount, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of unit_amount and unit_amount_decimal can be set.
    currency string
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    product string
    The ID of the Product that this Price will belong to.
    taxBehavior string
    Only required if a default tax behavior was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of inclusive, exclusive, or unspecified. Once specified as either inclusive or exclusive, it cannot be changed.
    unitAmount number
    A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge or a negative integer representing the amount to credit to the customer.
    unitAmountDecimal number
    Same as unit_amount, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of unit_amount and unit_amount_decimal can be set.
    currency str
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    product str
    The ID of the Product that this Price will belong to.
    tax_behavior str
    Only required if a default tax behavior was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of inclusive, exclusive, or unspecified. Once specified as either inclusive or exclusive, it cannot be changed.
    unit_amount float
    A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge or a negative integer representing the amount to credit to the customer.
    unit_amount_decimal float
    Same as unit_amount, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of unit_amount and unit_amount_decimal can be set.
    currency String
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    product String
    The ID of the Product that this Price will belong to.
    taxBehavior String
    Only required if a default tax behavior was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of inclusive, exclusive, or unspecified. Once specified as either inclusive or exclusive, it cannot be changed.
    unitAmount Number
    A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge or a negative integer representing the amount to credit to the customer.
    unitAmountDecimal Number
    Same as unit_amount, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of unit_amount and unit_amount_decimal can be set.

    SubscriptionAutomaticTax, SubscriptionAutomaticTaxArgs

    Enabled bool
    Whether Stripe automatically computes tax on this subscription.
    DisabledReason string
    If Stripe disabled automatic tax, this enum describes why.
    Liability SubscriptionAutomaticTaxLiability
    The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.
    Enabled bool
    Whether Stripe automatically computes tax on this subscription.
    DisabledReason string
    If Stripe disabled automatic tax, this enum describes why.
    Liability SubscriptionAutomaticTaxLiability
    The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.
    enabled bool
    Whether Stripe automatically computes tax on this subscription.
    disabled_reason string
    If Stripe disabled automatic tax, this enum describes why.
    liability object
    The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.
    enabled Boolean
    Whether Stripe automatically computes tax on this subscription.
    disabledReason String
    If Stripe disabled automatic tax, this enum describes why.
    liability SubscriptionAutomaticTaxLiability
    The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.
    enabled boolean
    Whether Stripe automatically computes tax on this subscription.
    disabledReason string
    If Stripe disabled automatic tax, this enum describes why.
    liability SubscriptionAutomaticTaxLiability
    The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.
    enabled bool
    Whether Stripe automatically computes tax on this subscription.
    disabled_reason str
    If Stripe disabled automatic tax, this enum describes why.
    liability SubscriptionAutomaticTaxLiability
    The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.
    enabled Boolean
    Whether Stripe automatically computes tax on this subscription.
    disabledReason String
    If Stripe disabled automatic tax, this enum describes why.
    liability Property Map
    The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.

    SubscriptionAutomaticTaxLiability, SubscriptionAutomaticTaxLiabilityArgs

    Type string
    Type of the account referenced.
    Account string
    The connected account being referenced when type is account.
    Type string
    Type of the account referenced.
    Account string
    The connected account being referenced when type is account.
    type string
    Type of the account referenced.
    account string
    The connected account being referenced when type is account.
    type String
    Type of the account referenced.
    account String
    The connected account being referenced when type is account.
    type string
    Type of the account referenced.
    account string
    The connected account being referenced when type is account.
    type str
    Type of the account referenced.
    account str
    The connected account being referenced when type is account.
    type String
    Type of the account referenced.
    account String
    The connected account being referenced when type is account.

    SubscriptionBillingCycleAnchorConfig, SubscriptionBillingCycleAnchorConfigArgs

    DayOfMonth double
    The day of the month of the billingcycleanchor.
    Hour double
    The hour of the day of the billingcycleanchor.
    Minute double
    The minute of the hour of the billingcycleanchor.
    Month double
    The month to start full cycle billing periods.
    Second double
    The second of the minute of the billingcycleanchor.
    DayOfMonth float64
    The day of the month of the billingcycleanchor.
    Hour float64
    The hour of the day of the billingcycleanchor.
    Minute float64
    The minute of the hour of the billingcycleanchor.
    Month float64
    The month to start full cycle billing periods.
    Second float64
    The second of the minute of the billingcycleanchor.
    day_of_month number
    The day of the month of the billingcycleanchor.
    hour number
    The hour of the day of the billingcycleanchor.
    minute number
    The minute of the hour of the billingcycleanchor.
    month number
    The month to start full cycle billing periods.
    second number
    The second of the minute of the billingcycleanchor.
    dayOfMonth Double
    The day of the month of the billingcycleanchor.
    hour Double
    The hour of the day of the billingcycleanchor.
    minute Double
    The minute of the hour of the billingcycleanchor.
    month Double
    The month to start full cycle billing periods.
    second Double
    The second of the minute of the billingcycleanchor.
    dayOfMonth number
    The day of the month of the billingcycleanchor.
    hour number
    The hour of the day of the billingcycleanchor.
    minute number
    The minute of the hour of the billingcycleanchor.
    month number
    The month to start full cycle billing periods.
    second number
    The second of the minute of the billingcycleanchor.
    day_of_month float
    The day of the month of the billingcycleanchor.
    hour float
    The hour of the day of the billingcycleanchor.
    minute float
    The minute of the hour of the billingcycleanchor.
    month float
    The month to start full cycle billing periods.
    second float
    The second of the minute of the billingcycleanchor.
    dayOfMonth Number
    The day of the month of the billingcycleanchor.
    hour Number
    The hour of the day of the billingcycleanchor.
    minute Number
    The minute of the hour of the billingcycleanchor.
    month Number
    The month to start full cycle billing periods.
    second Number
    The second of the minute of the billingcycleanchor.

    SubscriptionBillingMode, SubscriptionBillingModeArgs

    Type string
    Controls how prorations and invoices for subscriptions are calculated and orchestrated.
    Flexible SubscriptionBillingModeFlexible
    Configure behavior for flexible billing mode
    UpdatedAt double
    Details on when the current billing_mode was adopted.
    Type string
    Controls how prorations and invoices for subscriptions are calculated and orchestrated.
    Flexible SubscriptionBillingModeFlexible
    Configure behavior for flexible billing mode
    UpdatedAt float64
    Details on when the current billing_mode was adopted.
    type string
    Controls how prorations and invoices for subscriptions are calculated and orchestrated.
    flexible object
    Configure behavior for flexible billing mode
    updated_at number
    Details on when the current billing_mode was adopted.
    type String
    Controls how prorations and invoices for subscriptions are calculated and orchestrated.
    flexible SubscriptionBillingModeFlexible
    Configure behavior for flexible billing mode
    updatedAt Double
    Details on when the current billing_mode was adopted.
    type string
    Controls how prorations and invoices for subscriptions are calculated and orchestrated.
    flexible SubscriptionBillingModeFlexible
    Configure behavior for flexible billing mode
    updatedAt number
    Details on when the current billing_mode was adopted.
    type str
    Controls how prorations and invoices for subscriptions are calculated and orchestrated.
    flexible SubscriptionBillingModeFlexible
    Configure behavior for flexible billing mode
    updated_at float
    Details on when the current billing_mode was adopted.
    type String
    Controls how prorations and invoices for subscriptions are calculated and orchestrated.
    flexible Property Map
    Configure behavior for flexible billing mode
    updatedAt Number
    Details on when the current billing_mode was adopted.

    SubscriptionBillingModeFlexible, SubscriptionBillingModeFlexibleArgs

    ProrationDiscounts string
    Controls how invoices and invoice items display proration amounts and discount amounts.
    ProrationDiscounts string
    Controls how invoices and invoice items display proration amounts and discount amounts.
    proration_discounts string
    Controls how invoices and invoice items display proration amounts and discount amounts.
    prorationDiscounts String
    Controls how invoices and invoice items display proration amounts and discount amounts.
    prorationDiscounts string
    Controls how invoices and invoice items display proration amounts and discount amounts.
    proration_discounts str
    Controls how invoices and invoice items display proration amounts and discount amounts.
    prorationDiscounts String
    Controls how invoices and invoice items display proration amounts and discount amounts.

    SubscriptionBillingSchedule, SubscriptionBillingScheduleArgs

    BillUntil SubscriptionBillingScheduleBillUntil
    Specifies the end of billing period.
    AppliesTos List<SubscriptionBillingScheduleAppliesTo>
    Specifies which subscription items the billing schedule applies to.
    Key string
    Unique identifier for the billing schedule.
    BillUntil SubscriptionBillingScheduleBillUntil
    Specifies the end of billing period.
    AppliesTos []SubscriptionBillingScheduleAppliesTo
    Specifies which subscription items the billing schedule applies to.
    Key string
    Unique identifier for the billing schedule.
    bill_until object
    Specifies the end of billing period.
    applies_tos list(object)
    Specifies which subscription items the billing schedule applies to.
    key string
    Unique identifier for the billing schedule.
    billUntil SubscriptionBillingScheduleBillUntil
    Specifies the end of billing period.
    appliesTos List<SubscriptionBillingScheduleAppliesTo>
    Specifies which subscription items the billing schedule applies to.
    key String
    Unique identifier for the billing schedule.
    billUntil SubscriptionBillingScheduleBillUntil
    Specifies the end of billing period.
    appliesTos SubscriptionBillingScheduleAppliesTo[]
    Specifies which subscription items the billing schedule applies to.
    key string
    Unique identifier for the billing schedule.
    bill_until SubscriptionBillingScheduleBillUntil
    Specifies the end of billing period.
    applies_tos Sequence[SubscriptionBillingScheduleAppliesTo]
    Specifies which subscription items the billing schedule applies to.
    key str
    Unique identifier for the billing schedule.
    billUntil Property Map
    Specifies the end of billing period.
    appliesTos List<Property Map>
    Specifies which subscription items the billing schedule applies to.
    key String
    Unique identifier for the billing schedule.

    SubscriptionBillingScheduleAppliesTo, SubscriptionBillingScheduleAppliesToArgs

    Type string
    Controls which subscription items the billing schedule applies to.
    Price string
    The billing schedule will apply to the subscription item with the given price ID.
    Type string
    Controls which subscription items the billing schedule applies to.
    Price string
    The billing schedule will apply to the subscription item with the given price ID.
    type string
    Controls which subscription items the billing schedule applies to.
    price string
    The billing schedule will apply to the subscription item with the given price ID.
    type String
    Controls which subscription items the billing schedule applies to.
    price String
    The billing schedule will apply to the subscription item with the given price ID.
    type string
    Controls which subscription items the billing schedule applies to.
    price string
    The billing schedule will apply to the subscription item with the given price ID.
    type str
    Controls which subscription items the billing schedule applies to.
    price str
    The billing schedule will apply to the subscription item with the given price ID.
    type String
    Controls which subscription items the billing schedule applies to.
    price String
    The billing schedule will apply to the subscription item with the given price ID.

    SubscriptionBillingScheduleBillUntil, SubscriptionBillingScheduleBillUntilArgs

    Type string
    Describes how the billing schedule will determine the end date. Either duration or timestamp.
    ComputedTimestamp double
    The timestamp the billing schedule will apply until.
    Duration SubscriptionBillingScheduleBillUntilDuration
    Specifies the billing period.
    Timestamp double
    If specified, the billing schedule will apply until the specified timestamp.
    Type string
    Describes how the billing schedule will determine the end date. Either duration or timestamp.
    ComputedTimestamp float64
    The timestamp the billing schedule will apply until.
    Duration SubscriptionBillingScheduleBillUntilDuration
    Specifies the billing period.
    Timestamp float64
    If specified, the billing schedule will apply until the specified timestamp.
    type string
    Describes how the billing schedule will determine the end date. Either duration or timestamp.
    computed_timestamp number
    The timestamp the billing schedule will apply until.
    duration object
    Specifies the billing period.
    timestamp number
    If specified, the billing schedule will apply until the specified timestamp.
    type String
    Describes how the billing schedule will determine the end date. Either duration or timestamp.
    computedTimestamp Double
    The timestamp the billing schedule will apply until.
    duration SubscriptionBillingScheduleBillUntilDuration
    Specifies the billing period.
    timestamp Double
    If specified, the billing schedule will apply until the specified timestamp.
    type string
    Describes how the billing schedule will determine the end date. Either duration or timestamp.
    computedTimestamp number
    The timestamp the billing schedule will apply until.
    duration SubscriptionBillingScheduleBillUntilDuration
    Specifies the billing period.
    timestamp number
    If specified, the billing schedule will apply until the specified timestamp.
    type str
    Describes how the billing schedule will determine the end date. Either duration or timestamp.
    computed_timestamp float
    The timestamp the billing schedule will apply until.
    duration SubscriptionBillingScheduleBillUntilDuration
    Specifies the billing period.
    timestamp float
    If specified, the billing schedule will apply until the specified timestamp.
    type String
    Describes how the billing schedule will determine the end date. Either duration or timestamp.
    computedTimestamp Number
    The timestamp the billing schedule will apply until.
    duration Property Map
    Specifies the billing period.
    timestamp Number
    If specified, the billing schedule will apply until the specified timestamp.

    SubscriptionBillingScheduleBillUntilDuration, SubscriptionBillingScheduleBillUntilDurationArgs

    Interval string
    Specifies billing duration. Either day, week, month or year.
    IntervalCount double
    The multiplier applied to the interval.
    Interval string
    Specifies billing duration. Either day, week, month or year.
    IntervalCount float64
    The multiplier applied to the interval.
    interval string
    Specifies billing duration. Either day, week, month or year.
    interval_count number
    The multiplier applied to the interval.
    interval String
    Specifies billing duration. Either day, week, month or year.
    intervalCount Double
    The multiplier applied to the interval.
    interval string
    Specifies billing duration. Either day, week, month or year.
    intervalCount number
    The multiplier applied to the interval.
    interval str
    Specifies billing duration. Either day, week, month or year.
    interval_count float
    The multiplier applied to the interval.
    interval String
    Specifies billing duration. Either day, week, month or year.
    intervalCount Number
    The multiplier applied to the interval.

    SubscriptionBillingThresholds, SubscriptionBillingThresholdsArgs

    AmountGte double
    Monetary threshold that triggers the subscription to create an invoice
    ResetBillingCycleAnchor bool
    Indicates if the billing_cycle_anchor should be reset when a threshold is reached. If true, billing_cycle_anchor will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged. This value may not be true if the subscription contains items with plans that have aggregate_usage=last_ever.
    AmountGte float64
    Monetary threshold that triggers the subscription to create an invoice
    ResetBillingCycleAnchor bool
    Indicates if the billing_cycle_anchor should be reset when a threshold is reached. If true, billing_cycle_anchor will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged. This value may not be true if the subscription contains items with plans that have aggregate_usage=last_ever.
    amount_gte number
    Monetary threshold that triggers the subscription to create an invoice
    reset_billing_cycle_anchor bool
    Indicates if the billing_cycle_anchor should be reset when a threshold is reached. If true, billing_cycle_anchor will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged. This value may not be true if the subscription contains items with plans that have aggregate_usage=last_ever.
    amountGte Double
    Monetary threshold that triggers the subscription to create an invoice
    resetBillingCycleAnchor Boolean
    Indicates if the billing_cycle_anchor should be reset when a threshold is reached. If true, billing_cycle_anchor will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged. This value may not be true if the subscription contains items with plans that have aggregate_usage=last_ever.
    amountGte number
    Monetary threshold that triggers the subscription to create an invoice
    resetBillingCycleAnchor boolean
    Indicates if the billing_cycle_anchor should be reset when a threshold is reached. If true, billing_cycle_anchor will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged. This value may not be true if the subscription contains items with plans that have aggregate_usage=last_ever.
    amount_gte float
    Monetary threshold that triggers the subscription to create an invoice
    reset_billing_cycle_anchor bool
    Indicates if the billing_cycle_anchor should be reset when a threshold is reached. If true, billing_cycle_anchor will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged. This value may not be true if the subscription contains items with plans that have aggregate_usage=last_ever.
    amountGte Number
    Monetary threshold that triggers the subscription to create an invoice
    resetBillingCycleAnchor Boolean
    Indicates if the billing_cycle_anchor should be reset when a threshold is reached. If true, billing_cycle_anchor will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged. This value may not be true if the subscription contains items with plans that have aggregate_usage=last_ever.

    SubscriptionCancellationDetails, SubscriptionCancellationDetailsArgs

    Comment string
    Additional comments about why the user canceled the subscription, if the subscription was canceled explicitly by the user.
    Feedback string
    The customer submitted reason for why they canceled, if the subscription was canceled explicitly by the user.
    Reason string
    Why this subscription was canceled.
    Comment string
    Additional comments about why the user canceled the subscription, if the subscription was canceled explicitly by the user.
    Feedback string
    The customer submitted reason for why they canceled, if the subscription was canceled explicitly by the user.
    Reason string
    Why this subscription was canceled.
    comment string
    Additional comments about why the user canceled the subscription, if the subscription was canceled explicitly by the user.
    feedback string
    The customer submitted reason for why they canceled, if the subscription was canceled explicitly by the user.
    reason string
    Why this subscription was canceled.
    comment String
    Additional comments about why the user canceled the subscription, if the subscription was canceled explicitly by the user.
    feedback String
    The customer submitted reason for why they canceled, if the subscription was canceled explicitly by the user.
    reason String
    Why this subscription was canceled.
    comment string
    Additional comments about why the user canceled the subscription, if the subscription was canceled explicitly by the user.
    feedback string
    The customer submitted reason for why they canceled, if the subscription was canceled explicitly by the user.
    reason string
    Why this subscription was canceled.
    comment str
    Additional comments about why the user canceled the subscription, if the subscription was canceled explicitly by the user.
    feedback str
    The customer submitted reason for why they canceled, if the subscription was canceled explicitly by the user.
    reason str
    Why this subscription was canceled.
    comment String
    Additional comments about why the user canceled the subscription, if the subscription was canceled explicitly by the user.
    feedback String
    The customer submitted reason for why they canceled, if the subscription was canceled explicitly by the user.
    reason String
    Why this subscription was canceled.

    SubscriptionDiscount, SubscriptionDiscountArgs

    Coupon string
    ID of the coupon to create a new discount for.
    Discount string
    ID of an existing discount on the object (or one of its ancestors) to reuse.
    PromotionCode string
    ID of the promotion code to create a new discount for.
    Coupon string
    ID of the coupon to create a new discount for.
    Discount string
    ID of an existing discount on the object (or one of its ancestors) to reuse.
    PromotionCode string
    ID of the promotion code to create a new discount for.
    coupon string
    ID of the coupon to create a new discount for.
    discount string
    ID of an existing discount on the object (or one of its ancestors) to reuse.
    promotion_code string
    ID of the promotion code to create a new discount for.
    coupon String
    ID of the coupon to create a new discount for.
    discount String
    ID of an existing discount on the object (or one of its ancestors) to reuse.
    promotionCode String
    ID of the promotion code to create a new discount for.
    coupon string
    ID of the coupon to create a new discount for.
    discount string
    ID of an existing discount on the object (or one of its ancestors) to reuse.
    promotionCode string
    ID of the promotion code to create a new discount for.
    coupon str
    ID of the coupon to create a new discount for.
    discount str
    ID of an existing discount on the object (or one of its ancestors) to reuse.
    promotion_code str
    ID of the promotion code to create a new discount for.
    coupon String
    ID of the coupon to create a new discount for.
    discount String
    ID of an existing discount on the object (or one of its ancestors) to reuse.
    promotionCode String
    ID of the promotion code to create a new discount for.

    SubscriptionInvoiceSettings, SubscriptionInvoiceSettingsArgs

    AccountTaxIds List<string>
    The account tax IDs associated with the subscription. Will be set on invoices generated by the subscription.
    Issuer SubscriptionInvoiceSettingsIssuer
    AccountTaxIds []string
    The account tax IDs associated with the subscription. Will be set on invoices generated by the subscription.
    Issuer SubscriptionInvoiceSettingsIssuer
    account_tax_ids list(string)
    The account tax IDs associated with the subscription. Will be set on invoices generated by the subscription.
    issuer object
    accountTaxIds List<String>
    The account tax IDs associated with the subscription. Will be set on invoices generated by the subscription.
    issuer SubscriptionInvoiceSettingsIssuer
    accountTaxIds string[]
    The account tax IDs associated with the subscription. Will be set on invoices generated by the subscription.
    issuer SubscriptionInvoiceSettingsIssuer
    account_tax_ids Sequence[str]
    The account tax IDs associated with the subscription. Will be set on invoices generated by the subscription.
    issuer SubscriptionInvoiceSettingsIssuer
    accountTaxIds List<String>
    The account tax IDs associated with the subscription. Will be set on invoices generated by the subscription.
    issuer Property Map

    SubscriptionInvoiceSettingsIssuer, SubscriptionInvoiceSettingsIssuerArgs

    Type string
    Type of the account referenced.
    Account string
    The connected account being referenced when type is account.
    Type string
    Type of the account referenced.
    Account string
    The connected account being referenced when type is account.
    type string
    Type of the account referenced.
    account string
    The connected account being referenced when type is account.
    type String
    Type of the account referenced.
    account String
    The connected account being referenced when type is account.
    type string
    Type of the account referenced.
    account string
    The connected account being referenced when type is account.
    type str
    Type of the account referenced.
    account str
    The connected account being referenced when type is account.
    type String
    Type of the account referenced.
    account String
    The connected account being referenced when type is account.

    SubscriptionItem, SubscriptionItemArgs

    BillingThresholds SubscriptionItemBillingThresholds
    Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds.
    Discounts List<SubscriptionItemDiscount>
    The coupons to redeem into discounts for the subscription item.
    Id string
    Unique identifier for the object.
    Metadata Dictionary<string, string>
    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.
    Price string
    The ID of the price object.
    PriceData SubscriptionItemPriceData
    Data used to generate a new Price object inline.
    Quantity double
    Quantity for this item.
    TaxRates List<string>
    A list of Tax Rate ids. These Tax Rates will override the default_tax_rates on the Subscription. When updating, pass an empty string to remove previously-defined tax rates.
    BillingThresholds SubscriptionItemBillingThresholds
    Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds.
    Discounts []SubscriptionItemDiscount
    The coupons to redeem into discounts for the subscription item.
    Id string
    Unique identifier for the object.
    Metadata map[string]string
    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.
    Price string
    The ID of the price object.
    PriceData SubscriptionItemPriceData
    Data used to generate a new Price object inline.
    Quantity float64
    Quantity for this item.
    TaxRates []string
    A list of Tax Rate ids. These Tax Rates will override the default_tax_rates on the Subscription. When updating, pass an empty string to remove previously-defined tax rates.
    billing_thresholds object
    Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds.
    discounts list(object)
    The coupons to redeem into discounts for the subscription item.
    id string
    Unique identifier for the object.
    metadata map(string)
    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.
    price string
    The ID of the price object.
    price_data object
    Data used to generate a new Price object inline.
    quantity number
    Quantity for this item.
    tax_rates list(string)
    A list of Tax Rate ids. These Tax Rates will override the default_tax_rates on the Subscription. When updating, pass an empty string to remove previously-defined tax rates.
    billingThresholds SubscriptionItemBillingThresholds
    Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds.
    discounts List<SubscriptionItemDiscount>
    The coupons to redeem into discounts for the subscription item.
    id String
    Unique identifier for the object.
    metadata Map<String,String>
    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.
    price String
    The ID of the price object.
    priceData SubscriptionItemPriceData
    Data used to generate a new Price object inline.
    quantity Double
    Quantity for this item.
    taxRates List<String>
    A list of Tax Rate ids. These Tax Rates will override the default_tax_rates on the Subscription. When updating, pass an empty string to remove previously-defined tax rates.
    billingThresholds SubscriptionItemBillingThresholds
    Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds.
    discounts SubscriptionItemDiscount[]
    The coupons to redeem into discounts for the subscription item.
    id string
    Unique identifier for the object.
    metadata {[key: string]: string}
    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.
    price string
    The ID of the price object.
    priceData SubscriptionItemPriceData
    Data used to generate a new Price object inline.
    quantity number
    Quantity for this item.
    taxRates string[]
    A list of Tax Rate ids. These Tax Rates will override the default_tax_rates on the Subscription. When updating, pass an empty string to remove previously-defined tax rates.
    billing_thresholds SubscriptionItemBillingThresholds
    Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds.
    discounts Sequence[SubscriptionItemDiscount]
    The coupons to redeem into discounts for the subscription item.
    id str
    Unique identifier for the object.
    metadata Mapping[str, str]
    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.
    price str
    The ID of the price object.
    price_data SubscriptionItemPriceData
    Data used to generate a new Price object inline.
    quantity float
    Quantity for this item.
    tax_rates Sequence[str]
    A list of Tax Rate ids. These Tax Rates will override the default_tax_rates on the Subscription. When updating, pass an empty string to remove previously-defined tax rates.
    billingThresholds Property Map
    Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds.
    discounts List<Property Map>
    The coupons to redeem into discounts for the subscription item.
    id String
    Unique identifier for the object.
    metadata Map<String>
    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.
    price String
    The ID of the price object.
    priceData Property Map
    Data used to generate a new Price object inline.
    quantity Number
    Quantity for this item.
    taxRates List<String>
    A list of Tax Rate ids. These Tax Rates will override the default_tax_rates on the Subscription. When updating, pass an empty string to remove previously-defined tax rates.

    SubscriptionItemBillingThresholds, SubscriptionItemBillingThresholdsArgs

    UsageGte double
    Usage threshold that triggers the subscription to create an invoice
    UsageGte float64
    Usage threshold that triggers the subscription to create an invoice
    usage_gte number
    Usage threshold that triggers the subscription to create an invoice
    usageGte Double
    Usage threshold that triggers the subscription to create an invoice
    usageGte number
    Usage threshold that triggers the subscription to create an invoice
    usage_gte float
    Usage threshold that triggers the subscription to create an invoice
    usageGte Number
    Usage threshold that triggers the subscription to create an invoice

    SubscriptionItemDiscount, SubscriptionItemDiscountArgs

    Coupon string
    ID of the coupon to create a new discount for.
    Discount string
    ID of an existing discount on the object (or one of its ancestors) to reuse.
    PromotionCode string
    ID of the promotion code to create a new discount for.
    Coupon string
    ID of the coupon to create a new discount for.
    Discount string
    ID of an existing discount on the object (or one of its ancestors) to reuse.
    PromotionCode string
    ID of the promotion code to create a new discount for.
    coupon string
    ID of the coupon to create a new discount for.
    discount string
    ID of an existing discount on the object (or one of its ancestors) to reuse.
    promotion_code string
    ID of the promotion code to create a new discount for.
    coupon String
    ID of the coupon to create a new discount for.
    discount String
    ID of an existing discount on the object (or one of its ancestors) to reuse.
    promotionCode String
    ID of the promotion code to create a new discount for.
    coupon string
    ID of the coupon to create a new discount for.
    discount string
    ID of an existing discount on the object (or one of its ancestors) to reuse.
    promotionCode string
    ID of the promotion code to create a new discount for.
    coupon str
    ID of the coupon to create a new discount for.
    discount str
    ID of an existing discount on the object (or one of its ancestors) to reuse.
    promotion_code str
    ID of the promotion code to create a new discount for.
    coupon String
    ID of the coupon to create a new discount for.
    discount String
    ID of an existing discount on the object (or one of its ancestors) to reuse.
    promotionCode String
    ID of the promotion code to create a new discount for.

    SubscriptionItemPriceData, SubscriptionItemPriceDataArgs

    Currency string
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    Product string
    The ID of the Product that this Price will belong to.
    Recurring SubscriptionItemPriceDataRecurring
    The recurring components of a price such as interval and interval_count.
    TaxBehavior string
    Only required if a default tax behavior was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of inclusive, exclusive, or unspecified. Once specified as either inclusive or exclusive, it cannot be changed.
    UnitAmount double
    A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
    UnitAmountDecimal double
    Same as unit_amount, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of unit_amount and unit_amount_decimal can be set.
    Currency string
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    Product string
    The ID of the Product that this Price will belong to.
    Recurring SubscriptionItemPriceDataRecurring
    The recurring components of a price such as interval and interval_count.
    TaxBehavior string
    Only required if a default tax behavior was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of inclusive, exclusive, or unspecified. Once specified as either inclusive or exclusive, it cannot be changed.
    UnitAmount float64
    A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
    UnitAmountDecimal float64
    Same as unit_amount, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of unit_amount and unit_amount_decimal can be set.
    currency string
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    product string
    The ID of the Product that this Price will belong to.
    recurring object
    The recurring components of a price such as interval and interval_count.
    tax_behavior string
    Only required if a default tax behavior was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of inclusive, exclusive, or unspecified. Once specified as either inclusive or exclusive, it cannot be changed.
    unit_amount number
    A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
    unit_amount_decimal number
    Same as unit_amount, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of unit_amount and unit_amount_decimal can be set.
    currency String
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    product String
    The ID of the Product that this Price will belong to.
    recurring SubscriptionItemPriceDataRecurring
    The recurring components of a price such as interval and interval_count.
    taxBehavior String
    Only required if a default tax behavior was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of inclusive, exclusive, or unspecified. Once specified as either inclusive or exclusive, it cannot be changed.
    unitAmount Double
    A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
    unitAmountDecimal Double
    Same as unit_amount, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of unit_amount and unit_amount_decimal can be set.
    currency string
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    product string
    The ID of the Product that this Price will belong to.
    recurring SubscriptionItemPriceDataRecurring
    The recurring components of a price such as interval and interval_count.
    taxBehavior string
    Only required if a default tax behavior was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of inclusive, exclusive, or unspecified. Once specified as either inclusive or exclusive, it cannot be changed.
    unitAmount number
    A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
    unitAmountDecimal number
    Same as unit_amount, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of unit_amount and unit_amount_decimal can be set.
    currency str
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    product str
    The ID of the Product that this Price will belong to.
    recurring SubscriptionItemPriceDataRecurring
    The recurring components of a price such as interval and interval_count.
    tax_behavior str
    Only required if a default tax behavior was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of inclusive, exclusive, or unspecified. Once specified as either inclusive or exclusive, it cannot be changed.
    unit_amount float
    A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
    unit_amount_decimal float
    Same as unit_amount, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of unit_amount and unit_amount_decimal can be set.
    currency String
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    product String
    The ID of the Product that this Price will belong to.
    recurring Property Map
    The recurring components of a price such as interval and interval_count.
    taxBehavior String
    Only required if a default tax behavior was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of inclusive, exclusive, or unspecified. Once specified as either inclusive or exclusive, it cannot be changed.
    unitAmount Number
    A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
    unitAmountDecimal Number
    Same as unit_amount, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of unit_amount and unit_amount_decimal can be set.

    SubscriptionItemPriceDataRecurring, SubscriptionItemPriceDataRecurringArgs

    Interval string
    Specifies billing frequency. Either day, week, month or year.
    IntervalCount double
    The number of intervals between subscription billings. For example, interval=month and interval_count=3 bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).
    Interval string
    Specifies billing frequency. Either day, week, month or year.
    IntervalCount float64
    The number of intervals between subscription billings. For example, interval=month and interval_count=3 bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).
    interval string
    Specifies billing frequency. Either day, week, month or year.
    interval_count number
    The number of intervals between subscription billings. For example, interval=month and interval_count=3 bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).
    interval String
    Specifies billing frequency. Either day, week, month or year.
    intervalCount Double
    The number of intervals between subscription billings. For example, interval=month and interval_count=3 bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).
    interval string
    Specifies billing frequency. Either day, week, month or year.
    intervalCount number
    The number of intervals between subscription billings. For example, interval=month and interval_count=3 bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).
    interval str
    Specifies billing frequency. Either day, week, month or year.
    interval_count float
    The number of intervals between subscription billings. For example, interval=month and interval_count=3 bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).
    interval String
    Specifies billing frequency. Either day, week, month or year.
    intervalCount Number
    The number of intervals between subscription billings. For example, interval=month and interval_count=3 bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).

    SubscriptionManagedPayments, SubscriptionManagedPaymentsArgs

    Enabled bool
    Set to true to enable Managed Payments, Stripe's merchant of record solution, for this session.
    Enabled bool
    Set to true to enable Managed Payments, Stripe's merchant of record solution, for this session.
    enabled bool
    Set to true to enable Managed Payments, Stripe's merchant of record solution, for this session.
    enabled Boolean
    Set to true to enable Managed Payments, Stripe's merchant of record solution, for this session.
    enabled boolean
    Set to true to enable Managed Payments, Stripe's merchant of record solution, for this session.
    enabled bool
    Set to true to enable Managed Payments, Stripe's merchant of record solution, for this session.
    enabled Boolean
    Set to true to enable Managed Payments, Stripe's merchant of record solution, for this session.

    SubscriptionPauseCollection, SubscriptionPauseCollectionArgs

    Behavior string
    The payment collection behavior for this subscription while paused.
    ResumesAt double
    The time after which the subscription will resume collecting payments.
    Behavior string
    The payment collection behavior for this subscription while paused.
    ResumesAt float64
    The time after which the subscription will resume collecting payments.
    behavior string
    The payment collection behavior for this subscription while paused.
    resumes_at number
    The time after which the subscription will resume collecting payments.
    behavior String
    The payment collection behavior for this subscription while paused.
    resumesAt Double
    The time after which the subscription will resume collecting payments.
    behavior string
    The payment collection behavior for this subscription while paused.
    resumesAt number
    The time after which the subscription will resume collecting payments.
    behavior str
    The payment collection behavior for this subscription while paused.
    resumes_at float
    The time after which the subscription will resume collecting payments.
    behavior String
    The payment collection behavior for this subscription while paused.
    resumesAt Number
    The time after which the subscription will resume collecting payments.

    SubscriptionPaymentSettings, SubscriptionPaymentSettingsArgs

    PaymentMethodOptions SubscriptionPaymentSettingsPaymentMethodOptions
    Payment-method-specific configuration to provide to invoices created by the subscription.
    PaymentMethodTypes List<string>
    The list of payment method types to provide to every invoice created by the subscription. If not set, Stripe attempts to automatically determine the types to use by looking at the invoice’s default payment method, the subscription’s default payment method, the customer’s default payment method, and your invoice template settings.
    SaveDefaultPaymentMethod string
    Configure whether Stripe updates subscription.default_payment_method when payment succeeds. Defaults to off.
    PaymentMethodOptions SubscriptionPaymentSettingsPaymentMethodOptions
    Payment-method-specific configuration to provide to invoices created by the subscription.
    PaymentMethodTypes []string
    The list of payment method types to provide to every invoice created by the subscription. If not set, Stripe attempts to automatically determine the types to use by looking at the invoice’s default payment method, the subscription’s default payment method, the customer’s default payment method, and your invoice template settings.
    SaveDefaultPaymentMethod string
    Configure whether Stripe updates subscription.default_payment_method when payment succeeds. Defaults to off.
    payment_method_options object
    Payment-method-specific configuration to provide to invoices created by the subscription.
    payment_method_types list(string)
    The list of payment method types to provide to every invoice created by the subscription. If not set, Stripe attempts to automatically determine the types to use by looking at the invoice’s default payment method, the subscription’s default payment method, the customer’s default payment method, and your invoice template settings.
    save_default_payment_method string
    Configure whether Stripe updates subscription.default_payment_method when payment succeeds. Defaults to off.
    paymentMethodOptions SubscriptionPaymentSettingsPaymentMethodOptions
    Payment-method-specific configuration to provide to invoices created by the subscription.
    paymentMethodTypes List<String>
    The list of payment method types to provide to every invoice created by the subscription. If not set, Stripe attempts to automatically determine the types to use by looking at the invoice’s default payment method, the subscription’s default payment method, the customer’s default payment method, and your invoice template settings.
    saveDefaultPaymentMethod String
    Configure whether Stripe updates subscription.default_payment_method when payment succeeds. Defaults to off.
    paymentMethodOptions SubscriptionPaymentSettingsPaymentMethodOptions
    Payment-method-specific configuration to provide to invoices created by the subscription.
    paymentMethodTypes string[]
    The list of payment method types to provide to every invoice created by the subscription. If not set, Stripe attempts to automatically determine the types to use by looking at the invoice’s default payment method, the subscription’s default payment method, the customer’s default payment method, and your invoice template settings.
    saveDefaultPaymentMethod string
    Configure whether Stripe updates subscription.default_payment_method when payment succeeds. Defaults to off.
    payment_method_options SubscriptionPaymentSettingsPaymentMethodOptions
    Payment-method-specific configuration to provide to invoices created by the subscription.
    payment_method_types Sequence[str]
    The list of payment method types to provide to every invoice created by the subscription. If not set, Stripe attempts to automatically determine the types to use by looking at the invoice’s default payment method, the subscription’s default payment method, the customer’s default payment method, and your invoice template settings.
    save_default_payment_method str
    Configure whether Stripe updates subscription.default_payment_method when payment succeeds. Defaults to off.
    paymentMethodOptions Property Map
    Payment-method-specific configuration to provide to invoices created by the subscription.
    paymentMethodTypes List<String>
    The list of payment method types to provide to every invoice created by the subscription. If not set, Stripe attempts to automatically determine the types to use by looking at the invoice’s default payment method, the subscription’s default payment method, the customer’s default payment method, and your invoice template settings.
    saveDefaultPaymentMethod String
    Configure whether Stripe updates subscription.default_payment_method when payment succeeds. Defaults to off.

    SubscriptionPaymentSettingsPaymentMethodOptions, SubscriptionPaymentSettingsPaymentMethodOptionsArgs

    AcssDebit SubscriptionPaymentSettingsPaymentMethodOptionsAcssDebit
    This sub-hash contains details about the Canadian pre-authorized debit payment method options to pass to invoices created by the subscription.
    Bancontact SubscriptionPaymentSettingsPaymentMethodOptionsBancontact
    This sub-hash contains details about the Bancontact payment method options to pass to invoices created by the subscription.
    Card SubscriptionPaymentSettingsPaymentMethodOptionsCard
    This sub-hash contains details about the Card payment method options to pass to invoices created by the subscription.
    CustomerBalance SubscriptionPaymentSettingsPaymentMethodOptionsCustomerBalance
    This sub-hash contains details about the Bank transfer payment method options to pass to invoices created by the subscription.
    Payto SubscriptionPaymentSettingsPaymentMethodOptionsPayto
    This sub-hash contains details about the PayTo payment method options to pass to invoices created by the subscription.
    Pix SubscriptionPaymentSettingsPaymentMethodOptionsPix
    This sub-hash contains details about the Pix payment method options to pass to invoices created by the subscription.
    Upi SubscriptionPaymentSettingsPaymentMethodOptionsUpi
    This sub-hash contains details about the UPI payment method options to pass to invoices created by the subscription.
    UsBankAccount SubscriptionPaymentSettingsPaymentMethodOptionsUsBankAccount
    This sub-hash contains details about the ACH direct debit payment method options to pass to invoices created by the subscription.
    AcssDebit SubscriptionPaymentSettingsPaymentMethodOptionsAcssDebit
    This sub-hash contains details about the Canadian pre-authorized debit payment method options to pass to invoices created by the subscription.
    Bancontact SubscriptionPaymentSettingsPaymentMethodOptionsBancontact
    This sub-hash contains details about the Bancontact payment method options to pass to invoices created by the subscription.
    Card SubscriptionPaymentSettingsPaymentMethodOptionsCard
    This sub-hash contains details about the Card payment method options to pass to invoices created by the subscription.
    CustomerBalance SubscriptionPaymentSettingsPaymentMethodOptionsCustomerBalance
    This sub-hash contains details about the Bank transfer payment method options to pass to invoices created by the subscription.
    Payto SubscriptionPaymentSettingsPaymentMethodOptionsPayto
    This sub-hash contains details about the PayTo payment method options to pass to invoices created by the subscription.
    Pix SubscriptionPaymentSettingsPaymentMethodOptionsPix
    This sub-hash contains details about the Pix payment method options to pass to invoices created by the subscription.
    Upi SubscriptionPaymentSettingsPaymentMethodOptionsUpi
    This sub-hash contains details about the UPI payment method options to pass to invoices created by the subscription.
    UsBankAccount SubscriptionPaymentSettingsPaymentMethodOptionsUsBankAccount
    This sub-hash contains details about the ACH direct debit payment method options to pass to invoices created by the subscription.
    acss_debit object
    This sub-hash contains details about the Canadian pre-authorized debit payment method options to pass to invoices created by the subscription.
    bancontact object
    This sub-hash contains details about the Bancontact payment method options to pass to invoices created by the subscription.
    card object
    This sub-hash contains details about the Card payment method options to pass to invoices created by the subscription.
    customer_balance object
    This sub-hash contains details about the Bank transfer payment method options to pass to invoices created by the subscription.
    payto object
    This sub-hash contains details about the PayTo payment method options to pass to invoices created by the subscription.
    pix object
    This sub-hash contains details about the Pix payment method options to pass to invoices created by the subscription.
    upi object
    This sub-hash contains details about the UPI payment method options to pass to invoices created by the subscription.
    us_bank_account object
    This sub-hash contains details about the ACH direct debit payment method options to pass to invoices created by the subscription.
    acssDebit SubscriptionPaymentSettingsPaymentMethodOptionsAcssDebit
    This sub-hash contains details about the Canadian pre-authorized debit payment method options to pass to invoices created by the subscription.
    bancontact SubscriptionPaymentSettingsPaymentMethodOptionsBancontact
    This sub-hash contains details about the Bancontact payment method options to pass to invoices created by the subscription.
    card SubscriptionPaymentSettingsPaymentMethodOptionsCard
    This sub-hash contains details about the Card payment method options to pass to invoices created by the subscription.
    customerBalance SubscriptionPaymentSettingsPaymentMethodOptionsCustomerBalance
    This sub-hash contains details about the Bank transfer payment method options to pass to invoices created by the subscription.
    payto SubscriptionPaymentSettingsPaymentMethodOptionsPayto
    This sub-hash contains details about the PayTo payment method options to pass to invoices created by the subscription.
    pix SubscriptionPaymentSettingsPaymentMethodOptionsPix
    This sub-hash contains details about the Pix payment method options to pass to invoices created by the subscription.
    upi SubscriptionPaymentSettingsPaymentMethodOptionsUpi
    This sub-hash contains details about the UPI payment method options to pass to invoices created by the subscription.
    usBankAccount SubscriptionPaymentSettingsPaymentMethodOptionsUsBankAccount
    This sub-hash contains details about the ACH direct debit payment method options to pass to invoices created by the subscription.
    acssDebit SubscriptionPaymentSettingsPaymentMethodOptionsAcssDebit
    This sub-hash contains details about the Canadian pre-authorized debit payment method options to pass to invoices created by the subscription.
    bancontact SubscriptionPaymentSettingsPaymentMethodOptionsBancontact
    This sub-hash contains details about the Bancontact payment method options to pass to invoices created by the subscription.
    card SubscriptionPaymentSettingsPaymentMethodOptionsCard
    This sub-hash contains details about the Card payment method options to pass to invoices created by the subscription.
    customerBalance SubscriptionPaymentSettingsPaymentMethodOptionsCustomerBalance
    This sub-hash contains details about the Bank transfer payment method options to pass to invoices created by the subscription.
    payto SubscriptionPaymentSettingsPaymentMethodOptionsPayto
    This sub-hash contains details about the PayTo payment method options to pass to invoices created by the subscription.
    pix SubscriptionPaymentSettingsPaymentMethodOptionsPix
    This sub-hash contains details about the Pix payment method options to pass to invoices created by the subscription.
    upi SubscriptionPaymentSettingsPaymentMethodOptionsUpi
    This sub-hash contains details about the UPI payment method options to pass to invoices created by the subscription.
    usBankAccount SubscriptionPaymentSettingsPaymentMethodOptionsUsBankAccount
    This sub-hash contains details about the ACH direct debit payment method options to pass to invoices created by the subscription.
    acss_debit SubscriptionPaymentSettingsPaymentMethodOptionsAcssDebit
    This sub-hash contains details about the Canadian pre-authorized debit payment method options to pass to invoices created by the subscription.
    bancontact SubscriptionPaymentSettingsPaymentMethodOptionsBancontact
    This sub-hash contains details about the Bancontact payment method options to pass to invoices created by the subscription.
    card SubscriptionPaymentSettingsPaymentMethodOptionsCard
    This sub-hash contains details about the Card payment method options to pass to invoices created by the subscription.
    customer_balance SubscriptionPaymentSettingsPaymentMethodOptionsCustomerBalance
    This sub-hash contains details about the Bank transfer payment method options to pass to invoices created by the subscription.
    payto SubscriptionPaymentSettingsPaymentMethodOptionsPayto
    This sub-hash contains details about the PayTo payment method options to pass to invoices created by the subscription.
    pix SubscriptionPaymentSettingsPaymentMethodOptionsPix
    This sub-hash contains details about the Pix payment method options to pass to invoices created by the subscription.
    upi SubscriptionPaymentSettingsPaymentMethodOptionsUpi
    This sub-hash contains details about the UPI payment method options to pass to invoices created by the subscription.
    us_bank_account SubscriptionPaymentSettingsPaymentMethodOptionsUsBankAccount
    This sub-hash contains details about the ACH direct debit payment method options to pass to invoices created by the subscription.
    acssDebit Property Map
    This sub-hash contains details about the Canadian pre-authorized debit payment method options to pass to invoices created by the subscription.
    bancontact Property Map
    This sub-hash contains details about the Bancontact payment method options to pass to invoices created by the subscription.
    card Property Map
    This sub-hash contains details about the Card payment method options to pass to invoices created by the subscription.
    customerBalance Property Map
    This sub-hash contains details about the Bank transfer payment method options to pass to invoices created by the subscription.
    payto Property Map
    This sub-hash contains details about the PayTo payment method options to pass to invoices created by the subscription.
    pix Property Map
    This sub-hash contains details about the Pix payment method options to pass to invoices created by the subscription.
    upi Property Map
    This sub-hash contains details about the UPI payment method options to pass to invoices created by the subscription.
    usBankAccount Property Map
    This sub-hash contains details about the ACH direct debit payment method options to pass to invoices created by the subscription.

    SubscriptionPaymentSettingsPaymentMethodOptionsAcssDebit, SubscriptionPaymentSettingsPaymentMethodOptionsAcssDebitArgs

    MandateOptions SubscriptionPaymentSettingsPaymentMethodOptionsAcssDebitMandateOptions
    VerificationMethod string
    Bank account verification method. The default value is automatic.
    MandateOptions SubscriptionPaymentSettingsPaymentMethodOptionsAcssDebitMandateOptions
    VerificationMethod string
    Bank account verification method. The default value is automatic.
    mandate_options object
    verification_method string
    Bank account verification method. The default value is automatic.
    mandateOptions SubscriptionPaymentSettingsPaymentMethodOptionsAcssDebitMandateOptions
    verificationMethod String
    Bank account verification method. The default value is automatic.
    mandateOptions SubscriptionPaymentSettingsPaymentMethodOptionsAcssDebitMandateOptions
    verificationMethod string
    Bank account verification method. The default value is automatic.
    mandate_options SubscriptionPaymentSettingsPaymentMethodOptionsAcssDebitMandateOptions
    verification_method str
    Bank account verification method. The default value is automatic.
    mandateOptions Property Map
    verificationMethod String
    Bank account verification method. The default value is automatic.

    SubscriptionPaymentSettingsPaymentMethodOptionsAcssDebitMandateOptions, SubscriptionPaymentSettingsPaymentMethodOptionsAcssDebitMandateOptionsArgs

    TransactionType string
    Transaction type of the mandate.
    TransactionType string
    Transaction type of the mandate.
    transaction_type string
    Transaction type of the mandate.
    transactionType String
    Transaction type of the mandate.
    transactionType string
    Transaction type of the mandate.
    transaction_type str
    Transaction type of the mandate.
    transactionType String
    Transaction type of the mandate.

    SubscriptionPaymentSettingsPaymentMethodOptionsBancontact, SubscriptionPaymentSettingsPaymentMethodOptionsBancontactArgs

    PreferredLanguage string
    Preferred language of the Bancontact authorization page that the customer is redirected to.
    PreferredLanguage string
    Preferred language of the Bancontact authorization page that the customer is redirected to.
    preferred_language string
    Preferred language of the Bancontact authorization page that the customer is redirected to.
    preferredLanguage String
    Preferred language of the Bancontact authorization page that the customer is redirected to.
    preferredLanguage string
    Preferred language of the Bancontact authorization page that the customer is redirected to.
    preferred_language str
    Preferred language of the Bancontact authorization page that the customer is redirected to.
    preferredLanguage String
    Preferred language of the Bancontact authorization page that the customer is redirected to.

    SubscriptionPaymentSettingsPaymentMethodOptionsCard, SubscriptionPaymentSettingsPaymentMethodOptionsCardArgs

    MandateOptions SubscriptionPaymentSettingsPaymentMethodOptionsCardMandateOptions
    Network string
    Selected network to process this Subscription on. Depends on the available networks of the card attached to the Subscription. Can be only set confirm-time.
    RequestThreeDSecure string
    We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and other requirements. However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Read our guide on manually requesting 3D Secure for more information on how this configuration interacts with Radar and our SCA Engine.
    MandateOptions SubscriptionPaymentSettingsPaymentMethodOptionsCardMandateOptions
    Network string
    Selected network to process this Subscription on. Depends on the available networks of the card attached to the Subscription. Can be only set confirm-time.
    RequestThreeDSecure string
    We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and other requirements. However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Read our guide on manually requesting 3D Secure for more information on how this configuration interacts with Radar and our SCA Engine.
    mandate_options object
    network string
    Selected network to process this Subscription on. Depends on the available networks of the card attached to the Subscription. Can be only set confirm-time.
    request_three_d_secure string
    We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and other requirements. However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Read our guide on manually requesting 3D Secure for more information on how this configuration interacts with Radar and our SCA Engine.
    mandateOptions SubscriptionPaymentSettingsPaymentMethodOptionsCardMandateOptions
    network String
    Selected network to process this Subscription on. Depends on the available networks of the card attached to the Subscription. Can be only set confirm-time.
    requestThreeDSecure String
    We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and other requirements. However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Read our guide on manually requesting 3D Secure for more information on how this configuration interacts with Radar and our SCA Engine.
    mandateOptions SubscriptionPaymentSettingsPaymentMethodOptionsCardMandateOptions
    network string
    Selected network to process this Subscription on. Depends on the available networks of the card attached to the Subscription. Can be only set confirm-time.
    requestThreeDSecure string
    We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and other requirements. However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Read our guide on manually requesting 3D Secure for more information on how this configuration interacts with Radar and our SCA Engine.
    mandate_options SubscriptionPaymentSettingsPaymentMethodOptionsCardMandateOptions
    network str
    Selected network to process this Subscription on. Depends on the available networks of the card attached to the Subscription. Can be only set confirm-time.
    request_three_d_secure str
    We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and other requirements. However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Read our guide on manually requesting 3D Secure for more information on how this configuration interacts with Radar and our SCA Engine.
    mandateOptions Property Map
    network String
    Selected network to process this Subscription on. Depends on the available networks of the card attached to the Subscription. Can be only set confirm-time.
    requestThreeDSecure String
    We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and other requirements. However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Read our guide on manually requesting 3D Secure for more information on how this configuration interacts with Radar and our SCA Engine.

    SubscriptionPaymentSettingsPaymentMethodOptionsCardMandateOptions, SubscriptionPaymentSettingsPaymentMethodOptionsCardMandateOptionsArgs

    Amount double
    Amount to be charged for future payments, specified in the presentment currency.
    AmountType string
    One of fixed or maximum. If fixed, the amount param refers to the exact amount to be charged in future payments. If maximum, the amount charged can be up to the value passed for the amount param.
    Description string
    A description of the mandate or subscription that is meant to be displayed to the customer.
    Amount float64
    Amount to be charged for future payments, specified in the presentment currency.
    AmountType string
    One of fixed or maximum. If fixed, the amount param refers to the exact amount to be charged in future payments. If maximum, the amount charged can be up to the value passed for the amount param.
    Description string
    A description of the mandate or subscription that is meant to be displayed to the customer.
    amount number
    Amount to be charged for future payments, specified in the presentment currency.
    amount_type string
    One of fixed or maximum. If fixed, the amount param refers to the exact amount to be charged in future payments. If maximum, the amount charged can be up to the value passed for the amount param.
    description string
    A description of the mandate or subscription that is meant to be displayed to the customer.
    amount Double
    Amount to be charged for future payments, specified in the presentment currency.
    amountType String
    One of fixed or maximum. If fixed, the amount param refers to the exact amount to be charged in future payments. If maximum, the amount charged can be up to the value passed for the amount param.
    description String
    A description of the mandate or subscription that is meant to be displayed to the customer.
    amount number
    Amount to be charged for future payments, specified in the presentment currency.
    amountType string
    One of fixed or maximum. If fixed, the amount param refers to the exact amount to be charged in future payments. If maximum, the amount charged can be up to the value passed for the amount param.
    description string
    A description of the mandate or subscription that is meant to be displayed to the customer.
    amount float
    Amount to be charged for future payments, specified in the presentment currency.
    amount_type str
    One of fixed or maximum. If fixed, the amount param refers to the exact amount to be charged in future payments. If maximum, the amount charged can be up to the value passed for the amount param.
    description str
    A description of the mandate or subscription that is meant to be displayed to the customer.
    amount Number
    Amount to be charged for future payments, specified in the presentment currency.
    amountType String
    One of fixed or maximum. If fixed, the amount param refers to the exact amount to be charged in future payments. If maximum, the amount charged can be up to the value passed for the amount param.
    description String
    A description of the mandate or subscription that is meant to be displayed to the customer.

    SubscriptionPaymentSettingsPaymentMethodOptionsCustomerBalance, SubscriptionPaymentSettingsPaymentMethodOptionsCustomerBalanceArgs

    BankTransfer SubscriptionPaymentSettingsPaymentMethodOptionsCustomerBalanceBankTransfer
    FundingType string
    The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: bank_transfer.
    BankTransfer SubscriptionPaymentSettingsPaymentMethodOptionsCustomerBalanceBankTransfer
    FundingType string
    The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: bank_transfer.
    bank_transfer object
    funding_type string
    The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: bank_transfer.
    bankTransfer SubscriptionPaymentSettingsPaymentMethodOptionsCustomerBalanceBankTransfer
    fundingType String
    The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: bank_transfer.
    bankTransfer SubscriptionPaymentSettingsPaymentMethodOptionsCustomerBalanceBankTransfer
    fundingType string
    The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: bank_transfer.
    bank_transfer SubscriptionPaymentSettingsPaymentMethodOptionsCustomerBalanceBankTransfer
    funding_type str
    The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: bank_transfer.
    bankTransfer Property Map
    fundingType String
    The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: bank_transfer.

    SubscriptionPaymentSettingsPaymentMethodOptionsCustomerBalanceBankTransfer, SubscriptionPaymentSettingsPaymentMethodOptionsCustomerBalanceBankTransferArgs

    EuBankTransfer SubscriptionPaymentSettingsPaymentMethodOptionsCustomerBalanceBankTransferEuBankTransfer
    Type string
    The bank transfer type that can be used for funding. Permitted values include: eu_bank_transfer, gb_bank_transfer, jp_bank_transfer, mx_bank_transfer, or us_bank_transfer.
    EuBankTransfer SubscriptionPaymentSettingsPaymentMethodOptionsCustomerBalanceBankTransferEuBankTransfer
    Type string
    The bank transfer type that can be used for funding. Permitted values include: eu_bank_transfer, gb_bank_transfer, jp_bank_transfer, mx_bank_transfer, or us_bank_transfer.
    eu_bank_transfer object
    type string
    The bank transfer type that can be used for funding. Permitted values include: eu_bank_transfer, gb_bank_transfer, jp_bank_transfer, mx_bank_transfer, or us_bank_transfer.
    euBankTransfer SubscriptionPaymentSettingsPaymentMethodOptionsCustomerBalanceBankTransferEuBankTransfer
    type String
    The bank transfer type that can be used for funding. Permitted values include: eu_bank_transfer, gb_bank_transfer, jp_bank_transfer, mx_bank_transfer, or us_bank_transfer.
    euBankTransfer SubscriptionPaymentSettingsPaymentMethodOptionsCustomerBalanceBankTransferEuBankTransfer
    type string
    The bank transfer type that can be used for funding. Permitted values include: eu_bank_transfer, gb_bank_transfer, jp_bank_transfer, mx_bank_transfer, or us_bank_transfer.
    eu_bank_transfer SubscriptionPaymentSettingsPaymentMethodOptionsCustomerBalanceBankTransferEuBankTransfer
    type str
    The bank transfer type that can be used for funding. Permitted values include: eu_bank_transfer, gb_bank_transfer, jp_bank_transfer, mx_bank_transfer, or us_bank_transfer.
    euBankTransfer Property Map
    type String
    The bank transfer type that can be used for funding. Permitted values include: eu_bank_transfer, gb_bank_transfer, jp_bank_transfer, mx_bank_transfer, or us_bank_transfer.

    SubscriptionPaymentSettingsPaymentMethodOptionsCustomerBalanceBankTransferEuBankTransfer, SubscriptionPaymentSettingsPaymentMethodOptionsCustomerBalanceBankTransferEuBankTransferArgs

    Country string
    The desired country code of the bank account information. Permitted values include: DE, FR, IE, or NL.
    Country string
    The desired country code of the bank account information. Permitted values include: DE, FR, IE, or NL.
    country string
    The desired country code of the bank account information. Permitted values include: DE, FR, IE, or NL.
    country String
    The desired country code of the bank account information. Permitted values include: DE, FR, IE, or NL.
    country string
    The desired country code of the bank account information. Permitted values include: DE, FR, IE, or NL.
    country str
    The desired country code of the bank account information. Permitted values include: DE, FR, IE, or NL.
    country String
    The desired country code of the bank account information. Permitted values include: DE, FR, IE, or NL.

    SubscriptionPaymentSettingsPaymentMethodOptionsPayto, SubscriptionPaymentSettingsPaymentMethodOptionsPaytoArgs

    SubscriptionPaymentSettingsPaymentMethodOptionsPaytoMandateOptions, SubscriptionPaymentSettingsPaymentMethodOptionsPaytoMandateOptionsArgs

    Amount double
    The maximum amount that can be collected in a single invoice. If you don't specify a maximum, then there is no limit.
    AmountType string
    Only maximum is supported.
    Purpose string
    The purpose for which payments are made. Has a default value based on your merchant category code.
    Amount float64
    The maximum amount that can be collected in a single invoice. If you don't specify a maximum, then there is no limit.
    AmountType string
    Only maximum is supported.
    Purpose string
    The purpose for which payments are made. Has a default value based on your merchant category code.
    amount number
    The maximum amount that can be collected in a single invoice. If you don't specify a maximum, then there is no limit.
    amount_type string
    Only maximum is supported.
    purpose string
    The purpose for which payments are made. Has a default value based on your merchant category code.
    amount Double
    The maximum amount that can be collected in a single invoice. If you don't specify a maximum, then there is no limit.
    amountType String
    Only maximum is supported.
    purpose String
    The purpose for which payments are made. Has a default value based on your merchant category code.
    amount number
    The maximum amount that can be collected in a single invoice. If you don't specify a maximum, then there is no limit.
    amountType string
    Only maximum is supported.
    purpose string
    The purpose for which payments are made. Has a default value based on your merchant category code.
    amount float
    The maximum amount that can be collected in a single invoice. If you don't specify a maximum, then there is no limit.
    amount_type str
    Only maximum is supported.
    purpose str
    The purpose for which payments are made. Has a default value based on your merchant category code.
    amount Number
    The maximum amount that can be collected in a single invoice. If you don't specify a maximum, then there is no limit.
    amountType String
    Only maximum is supported.
    purpose String
    The purpose for which payments are made. Has a default value based on your merchant category code.

    SubscriptionPaymentSettingsPaymentMethodOptionsPix, SubscriptionPaymentSettingsPaymentMethodOptionsPixArgs

    ExpiresAfterSeconds double
    The number of seconds (between 10 and 1209600) after which Pix payment will expire. Defaults to 86400 seconds.
    MandateOptions SubscriptionPaymentSettingsPaymentMethodOptionsPixMandateOptions
    ExpiresAfterSeconds float64
    The number of seconds (between 10 and 1209600) after which Pix payment will expire. Defaults to 86400 seconds.
    MandateOptions SubscriptionPaymentSettingsPaymentMethodOptionsPixMandateOptions
    expires_after_seconds number
    The number of seconds (between 10 and 1209600) after which Pix payment will expire. Defaults to 86400 seconds.
    mandate_options object
    expiresAfterSeconds Double
    The number of seconds (between 10 and 1209600) after which Pix payment will expire. Defaults to 86400 seconds.
    mandateOptions SubscriptionPaymentSettingsPaymentMethodOptionsPixMandateOptions
    expiresAfterSeconds number
    The number of seconds (between 10 and 1209600) after which Pix payment will expire. Defaults to 86400 seconds.
    mandateOptions SubscriptionPaymentSettingsPaymentMethodOptionsPixMandateOptions
    expires_after_seconds float
    The number of seconds (between 10 and 1209600) after which Pix payment will expire. Defaults to 86400 seconds.
    mandate_options SubscriptionPaymentSettingsPaymentMethodOptionsPixMandateOptions
    expiresAfterSeconds Number
    The number of seconds (between 10 and 1209600) after which Pix payment will expire. Defaults to 86400 seconds.
    mandateOptions Property Map

    SubscriptionPaymentSettingsPaymentMethodOptionsPixMandateOptions, SubscriptionPaymentSettingsPaymentMethodOptionsPixMandateOptionsArgs

    Amount double
    Amount to be charged for future payments.
    AmountIncludesIof string
    Determines if the amount includes the IOF tax.
    EndDate string
    Date when the mandate expires and no further payments will be charged, in YYYY-MM-DD.
    PaymentSchedule string
    Schedule at which the future payments will be charged.
    Amount float64
    Amount to be charged for future payments.
    AmountIncludesIof string
    Determines if the amount includes the IOF tax.
    EndDate string
    Date when the mandate expires and no further payments will be charged, in YYYY-MM-DD.
    PaymentSchedule string
    Schedule at which the future payments will be charged.
    amount number
    Amount to be charged for future payments.
    amount_includes_iof string
    Determines if the amount includes the IOF tax.
    end_date string
    Date when the mandate expires and no further payments will be charged, in YYYY-MM-DD.
    payment_schedule string
    Schedule at which the future payments will be charged.
    amount Double
    Amount to be charged for future payments.
    amountIncludesIof String
    Determines if the amount includes the IOF tax.
    endDate String
    Date when the mandate expires and no further payments will be charged, in YYYY-MM-DD.
    paymentSchedule String
    Schedule at which the future payments will be charged.
    amount number
    Amount to be charged for future payments.
    amountIncludesIof string
    Determines if the amount includes the IOF tax.
    endDate string
    Date when the mandate expires and no further payments will be charged, in YYYY-MM-DD.
    paymentSchedule string
    Schedule at which the future payments will be charged.
    amount float
    Amount to be charged for future payments.
    amount_includes_iof str
    Determines if the amount includes the IOF tax.
    end_date str
    Date when the mandate expires and no further payments will be charged, in YYYY-MM-DD.
    payment_schedule str
    Schedule at which the future payments will be charged.
    amount Number
    Amount to be charged for future payments.
    amountIncludesIof String
    Determines if the amount includes the IOF tax.
    endDate String
    Date when the mandate expires and no further payments will be charged, in YYYY-MM-DD.
    paymentSchedule String
    Schedule at which the future payments will be charged.

    SubscriptionPaymentSettingsPaymentMethodOptionsUpi, SubscriptionPaymentSettingsPaymentMethodOptionsUpiArgs

    SubscriptionPaymentSettingsPaymentMethodOptionsUpiMandateOptions, SubscriptionPaymentSettingsPaymentMethodOptionsUpiMandateOptionsArgs

    Amount double
    Amount to be charged for future payments.
    AmountType string
    One of fixed or maximum. If fixed, the amount param refers to the exact amount to be charged in future payments. If maximum, the amount charged can be up to the value passed for the amount param.
    Description string
    A description of the mandate or subscription that is meant to be displayed to the customer.
    EndDate double
    End date of the mandate or subscription.
    Amount float64
    Amount to be charged for future payments.
    AmountType string
    One of fixed or maximum. If fixed, the amount param refers to the exact amount to be charged in future payments. If maximum, the amount charged can be up to the value passed for the amount param.
    Description string
    A description of the mandate or subscription that is meant to be displayed to the customer.
    EndDate float64
    End date of the mandate or subscription.
    amount number
    Amount to be charged for future payments.
    amount_type string
    One of fixed or maximum. If fixed, the amount param refers to the exact amount to be charged in future payments. If maximum, the amount charged can be up to the value passed for the amount param.
    description string
    A description of the mandate or subscription that is meant to be displayed to the customer.
    end_date number
    End date of the mandate or subscription.
    amount Double
    Amount to be charged for future payments.
    amountType String
    One of fixed or maximum. If fixed, the amount param refers to the exact amount to be charged in future payments. If maximum, the amount charged can be up to the value passed for the amount param.
    description String
    A description of the mandate or subscription that is meant to be displayed to the customer.
    endDate Double
    End date of the mandate or subscription.
    amount number
    Amount to be charged for future payments.
    amountType string
    One of fixed or maximum. If fixed, the amount param refers to the exact amount to be charged in future payments. If maximum, the amount charged can be up to the value passed for the amount param.
    description string
    A description of the mandate or subscription that is meant to be displayed to the customer.
    endDate number
    End date of the mandate or subscription.
    amount float
    Amount to be charged for future payments.
    amount_type str
    One of fixed or maximum. If fixed, the amount param refers to the exact amount to be charged in future payments. If maximum, the amount charged can be up to the value passed for the amount param.
    description str
    A description of the mandate or subscription that is meant to be displayed to the customer.
    end_date float
    End date of the mandate or subscription.
    amount Number
    Amount to be charged for future payments.
    amountType String
    One of fixed or maximum. If fixed, the amount param refers to the exact amount to be charged in future payments. If maximum, the amount charged can be up to the value passed for the amount param.
    description String
    A description of the mandate or subscription that is meant to be displayed to the customer.
    endDate Number
    End date of the mandate or subscription.

    SubscriptionPaymentSettingsPaymentMethodOptionsUsBankAccount, SubscriptionPaymentSettingsPaymentMethodOptionsUsBankAccountArgs

    financial_connections object
    verification_method string
    Bank account verification method. The default value is automatic.
    financialConnections Property Map
    verificationMethod String
    Bank account verification method. The default value is automatic.

    SubscriptionPaymentSettingsPaymentMethodOptionsUsBankAccountFinancialConnections, SubscriptionPaymentSettingsPaymentMethodOptionsUsBankAccountFinancialConnectionsArgs

    Filters SubscriptionPaymentSettingsPaymentMethodOptionsUsBankAccountFinancialConnectionsFilters
    Permissions List<string>
    The list of permissions to request. The payment_method permission must be included.
    Prefetches List<string>
    Data features requested to be retrieved upon account creation.
    Filters SubscriptionPaymentSettingsPaymentMethodOptionsUsBankAccountFinancialConnectionsFilters
    Permissions []string
    The list of permissions to request. The payment_method permission must be included.
    Prefetches []string
    Data features requested to be retrieved upon account creation.
    filters object
    permissions list(string)
    The list of permissions to request. The payment_method permission must be included.
    prefetches list(string)
    Data features requested to be retrieved upon account creation.
    filters SubscriptionPaymentSettingsPaymentMethodOptionsUsBankAccountFinancialConnectionsFilters
    permissions List<String>
    The list of permissions to request. The payment_method permission must be included.
    prefetches List<String>
    Data features requested to be retrieved upon account creation.
    filters SubscriptionPaymentSettingsPaymentMethodOptionsUsBankAccountFinancialConnectionsFilters
    permissions string[]
    The list of permissions to request. The payment_method permission must be included.
    prefetches string[]
    Data features requested to be retrieved upon account creation.
    filters SubscriptionPaymentSettingsPaymentMethodOptionsUsBankAccountFinancialConnectionsFilters
    permissions Sequence[str]
    The list of permissions to request. The payment_method permission must be included.
    prefetches Sequence[str]
    Data features requested to be retrieved upon account creation.
    filters Property Map
    permissions List<String>
    The list of permissions to request. The payment_method permission must be included.
    prefetches List<String>
    Data features requested to be retrieved upon account creation.

    SubscriptionPaymentSettingsPaymentMethodOptionsUsBankAccountFinancialConnectionsFilters, SubscriptionPaymentSettingsPaymentMethodOptionsUsBankAccountFinancialConnectionsFiltersArgs

    AccountSubcategories List<string>
    The account subcategories to use to filter for possible accounts to link. Valid subcategories are checking and savings.
    AccountSubcategories []string
    The account subcategories to use to filter for possible accounts to link. Valid subcategories are checking and savings.
    account_subcategories list(string)
    The account subcategories to use to filter for possible accounts to link. Valid subcategories are checking and savings.
    accountSubcategories List<String>
    The account subcategories to use to filter for possible accounts to link. Valid subcategories are checking and savings.
    accountSubcategories string[]
    The account subcategories to use to filter for possible accounts to link. Valid subcategories are checking and savings.
    account_subcategories Sequence[str]
    The account subcategories to use to filter for possible accounts to link. Valid subcategories are checking and savings.
    accountSubcategories List<String>
    The account subcategories to use to filter for possible accounts to link. Valid subcategories are checking and savings.

    SubscriptionPendingInvoiceItemInterval, SubscriptionPendingInvoiceItemIntervalArgs

    Interval string
    Specifies invoicing frequency. Either day, week, month or year.
    IntervalCount double
    The number of intervals between invoices. For example, interval=month and interval_count=3 bills every 3 months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks).
    Interval string
    Specifies invoicing frequency. Either day, week, month or year.
    IntervalCount float64
    The number of intervals between invoices. For example, interval=month and interval_count=3 bills every 3 months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks).
    interval string
    Specifies invoicing frequency. Either day, week, month or year.
    interval_count number
    The number of intervals between invoices. For example, interval=month and interval_count=3 bills every 3 months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks).
    interval String
    Specifies invoicing frequency. Either day, week, month or year.
    intervalCount Double
    The number of intervals between invoices. For example, interval=month and interval_count=3 bills every 3 months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks).
    interval string
    Specifies invoicing frequency. Either day, week, month or year.
    intervalCount number
    The number of intervals between invoices. For example, interval=month and interval_count=3 bills every 3 months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks).
    interval str
    Specifies invoicing frequency. Either day, week, month or year.
    interval_count float
    The number of intervals between invoices. For example, interval=month and interval_count=3 bills every 3 months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks).
    interval String
    Specifies invoicing frequency. Either day, week, month or year.
    intervalCount Number
    The number of intervals between invoices. For example, interval=month and interval_count=3 bills every 3 months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks).

    SubscriptionPendingUpdate, SubscriptionPendingUpdateArgs

    BillingCycleAnchor double
    If the update is applied, determines the date of the first full invoice, and, for plans with month or year intervals, the day of the month for subsequent invoices. The timestamp is in UTC format.
    Discount string
    The pending subscription-level discount that will be applied when the pending update is applied.
    ExpiresAt double
    The point after which the changes reflected by this update will be discarded and no longer applied.
    Metadata Dictionary<string, string>
    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
    TrialEnd double
    Unix timestamp representing the end of the trial period the customer will get before being charged for the first time, if the update is applied.
    TrialFromPlan bool
    Indicates if a plan's trial_period_days should be applied to the subscription. Setting trial_end per subscription is preferred, and this defaults to false. Setting this flag to true together with trial_end is not allowed. See Using trial periods on subscriptions to learn more.
    BillingCycleAnchor float64
    If the update is applied, determines the date of the first full invoice, and, for plans with month or year intervals, the day of the month for subsequent invoices. The timestamp is in UTC format.
    Discount string
    The pending subscription-level discount that will be applied when the pending update is applied.
    ExpiresAt float64
    The point after which the changes reflected by this update will be discarded and no longer applied.
    Metadata map[string]string
    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
    TrialEnd float64
    Unix timestamp representing the end of the trial period the customer will get before being charged for the first time, if the update is applied.
    TrialFromPlan bool
    Indicates if a plan's trial_period_days should be applied to the subscription. Setting trial_end per subscription is preferred, and this defaults to false. Setting this flag to true together with trial_end is not allowed. See Using trial periods on subscriptions to learn more.
    billing_cycle_anchor number
    If the update is applied, determines the date of the first full invoice, and, for plans with month or year intervals, the day of the month for subsequent invoices. The timestamp is in UTC format.
    discount string
    The pending subscription-level discount that will be applied when the pending update is applied.
    expires_at number
    The point after which the changes reflected by this update will be discarded and no longer applied.
    metadata map(string)
    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
    trial_end number
    Unix timestamp representing the end of the trial period the customer will get before being charged for the first time, if the update is applied.
    trial_from_plan bool
    Indicates if a plan's trial_period_days should be applied to the subscription. Setting trial_end per subscription is preferred, and this defaults to false. Setting this flag to true together with trial_end is not allowed. See Using trial periods on subscriptions to learn more.
    billingCycleAnchor Double
    If the update is applied, determines the date of the first full invoice, and, for plans with month or year intervals, the day of the month for subsequent invoices. The timestamp is in UTC format.
    discount String
    The pending subscription-level discount that will be applied when the pending update is applied.
    expiresAt Double
    The point after which the changes reflected by this update will be discarded and no longer applied.
    metadata Map<String,String>
    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
    trialEnd Double
    Unix timestamp representing the end of the trial period the customer will get before being charged for the first time, if the update is applied.
    trialFromPlan Boolean
    Indicates if a plan's trial_period_days should be applied to the subscription. Setting trial_end per subscription is preferred, and this defaults to false. Setting this flag to true together with trial_end is not allowed. See Using trial periods on subscriptions to learn more.
    billingCycleAnchor number
    If the update is applied, determines the date of the first full invoice, and, for plans with month or year intervals, the day of the month for subsequent invoices. The timestamp is in UTC format.
    discount string
    The pending subscription-level discount that will be applied when the pending update is applied.
    expiresAt number
    The point after which the changes reflected by this update will be discarded and no longer applied.
    metadata {[key: string]: string}
    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
    trialEnd number
    Unix timestamp representing the end of the trial period the customer will get before being charged for the first time, if the update is applied.
    trialFromPlan boolean
    Indicates if a plan's trial_period_days should be applied to the subscription. Setting trial_end per subscription is preferred, and this defaults to false. Setting this flag to true together with trial_end is not allowed. See Using trial periods on subscriptions to learn more.
    billing_cycle_anchor float
    If the update is applied, determines the date of the first full invoice, and, for plans with month or year intervals, the day of the month for subsequent invoices. The timestamp is in UTC format.
    discount str
    The pending subscription-level discount that will be applied when the pending update is applied.
    expires_at float
    The point after which the changes reflected by this update will be discarded and no longer applied.
    metadata Mapping[str, str]
    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
    trial_end float
    Unix timestamp representing the end of the trial period the customer will get before being charged for the first time, if the update is applied.
    trial_from_plan bool
    Indicates if a plan's trial_period_days should be applied to the subscription. Setting trial_end per subscription is preferred, and this defaults to false. Setting this flag to true together with trial_end is not allowed. See Using trial periods on subscriptions to learn more.
    billingCycleAnchor Number
    If the update is applied, determines the date of the first full invoice, and, for plans with month or year intervals, the day of the month for subsequent invoices. The timestamp is in UTC format.
    discount String
    The pending subscription-level discount that will be applied when the pending update is applied.
    expiresAt Number
    The point after which the changes reflected by this update will be discarded and no longer applied.
    metadata Map<String>
    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
    trialEnd Number
    Unix timestamp representing the end of the trial period the customer will get before being charged for the first time, if the update is applied.
    trialFromPlan Boolean
    Indicates if a plan's trial_period_days should be applied to the subscription. Setting trial_end per subscription is preferred, and this defaults to false. Setting this flag to true together with trial_end is not allowed. See Using trial periods on subscriptions to learn more.

    SubscriptionPresentmentDetails, SubscriptionPresentmentDetailsArgs

    PresentmentCurrency string
    Currency used for customer payments.
    PresentmentCurrency string
    Currency used for customer payments.
    presentment_currency string
    Currency used for customer payments.
    presentmentCurrency String
    Currency used for customer payments.
    presentmentCurrency string
    Currency used for customer payments.
    presentment_currency str
    Currency used for customer payments.
    presentmentCurrency String
    Currency used for customer payments.

    SubscriptionTransferData, SubscriptionTransferDataArgs

    Destination string
    The account where funds from the payment will be transferred to upon payment success.
    AmountPercent double
    A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount is transferred to the destination.
    Destination string
    The account where funds from the payment will be transferred to upon payment success.
    AmountPercent float64
    A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount is transferred to the destination.
    destination string
    The account where funds from the payment will be transferred to upon payment success.
    amount_percent number
    A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount is transferred to the destination.
    destination String
    The account where funds from the payment will be transferred to upon payment success.
    amountPercent Double
    A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount is transferred to the destination.
    destination string
    The account where funds from the payment will be transferred to upon payment success.
    amountPercent number
    A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount is transferred to the destination.
    destination str
    The account where funds from the payment will be transferred to upon payment success.
    amount_percent float
    A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount is transferred to the destination.
    destination String
    The account where funds from the payment will be transferred to upon payment success.
    amountPercent Number
    A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount is transferred to the destination.

    SubscriptionTrialSettings, SubscriptionTrialSettingsArgs

    EndBehavior SubscriptionTrialSettingsEndBehavior
    Defines how a subscription behaves when a trial ends.
    EndBehavior SubscriptionTrialSettingsEndBehavior
    Defines how a subscription behaves when a trial ends.
    end_behavior object
    Defines how a subscription behaves when a trial ends.
    endBehavior SubscriptionTrialSettingsEndBehavior
    Defines how a subscription behaves when a trial ends.
    endBehavior SubscriptionTrialSettingsEndBehavior
    Defines how a subscription behaves when a trial ends.
    end_behavior SubscriptionTrialSettingsEndBehavior
    Defines how a subscription behaves when a trial ends.
    endBehavior Property Map
    Defines how a subscription behaves when a trial ends.

    SubscriptionTrialSettingsEndBehavior, SubscriptionTrialSettingsEndBehaviorArgs

    MissingPaymentMethod string
    Indicates how the subscription should change when the trial ends if the user did not provide a payment method.
    MissingPaymentMethod string
    Indicates how the subscription should change when the trial ends if the user did not provide a payment method.
    missing_payment_method string
    Indicates how the subscription should change when the trial ends if the user did not provide a payment method.
    missingPaymentMethod String
    Indicates how the subscription should change when the trial ends if the user did not provide a payment method.
    missingPaymentMethod string
    Indicates how the subscription should change when the trial ends if the user did not provide a payment method.
    missing_payment_method str
    Indicates how the subscription should change when the trial ends if the user did not provide a payment method.
    missingPaymentMethod String
    Indicates how the subscription should change when the trial ends if the user did not provide a payment method.

    Package Details

    Repository
    stripe stripe/terraform-provider-stripe
    License
    Notes
    This Pulumi package is based on the stripe Terraform Provider.
    Viewing docs for Stripe 0.3.0
    published on Friday, Aug 14, 2026 by Pulumi
    Schema (JSON)
    stripe/terraform-provider-stripe

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial