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

stripe.SubscriptionSchedule

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

    A subscription schedule allows you to create and manage the lifecycle of a subscription by predefining expected changes.

    Related guide: Subscription schedules

    Create SubscriptionSchedule Resource

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

    Constructor syntax

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

@overload
def SubscriptionSchedule(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         billing_mode: Optional[SubscriptionScheduleBillingModeArgs] = None,
                         customer: Optional[str] = None,
                         customer_account: Optional[str] = None,
                         default_settings: Optional[SubscriptionScheduleDefaultSettingsArgs] = None,
                         end_behavior: Optional[str] = None,
                         from_subscription: Optional[str] = None,
                         metadata: Optional[Mapping[str, str]] = None,
                         phases: Optional[Sequence[SubscriptionSchedulePhaseArgs]] = None,
                         start_date: Optional[float] = None)
    func NewSubscriptionSchedule(ctx *Context, name string, args *SubscriptionScheduleArgs, opts ...ResourceOption) (*SubscriptionSchedule, error)
    public SubscriptionSchedule(string name, SubscriptionScheduleArgs? args = null, CustomResourceOptions? opts = null)
    public SubscriptionSchedule(String name, SubscriptionScheduleArgs args)
public SubscriptionSchedule(String name, SubscriptionScheduleArgs args, CustomResourceOptions options)

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


    resource "stripe_subscription_schedule" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args SubscriptionScheduleArgs
    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 SubscriptionScheduleArgs
    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 SubscriptionScheduleArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SubscriptionScheduleArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SubscriptionScheduleArgs
    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 subscriptionScheduleResource = new Stripe.SubscriptionSchedule("subscriptionScheduleResource", new()
{
    BillingMode = new Stripe.Inputs.SubscriptionScheduleBillingModeArgs
    {
        Type = "string",
        Flexible = new Stripe.Inputs.SubscriptionScheduleBillingModeFlexibleArgs
        {
            ProrationDiscounts = "string",
        },
        UpdatedAt = 0.0,
    },
    Customer = "string",
    CustomerAccount = "string",
    DefaultSettings = new Stripe.Inputs.SubscriptionScheduleDefaultSettingsArgs
    {
        ApplicationFeePercent = 0.0,
        AutomaticTax = new Stripe.Inputs.SubscriptionScheduleDefaultSettingsAutomaticTaxArgs
        {
            Enabled = false,
            DisabledReason = "string",
            Liability = new Stripe.Inputs.SubscriptionScheduleDefaultSettingsAutomaticTaxLiabilityArgs
            {
                Type = "string",
                Account = "string",
            },
        },
        BillingCycleAnchor = "string",
        BillingThresholds = new Stripe.Inputs.SubscriptionScheduleDefaultSettingsBillingThresholdsArgs
        {
            AmountGte = 0.0,
            ResetBillingCycleAnchor = false,
        },
        CollectionMethod = "string",
        DefaultPaymentMethod = "string",
        Description = "string",
        InvoiceSettings = new Stripe.Inputs.SubscriptionScheduleDefaultSettingsInvoiceSettingsArgs
        {
            AccountTaxIds = new[]
            {
                "string",
            },
            DaysUntilDue = 0.0,
            Issuer = new Stripe.Inputs.SubscriptionScheduleDefaultSettingsInvoiceSettingsIssuerArgs
            {
                Type = "string",
                Account = "string",
            },
        },
        OnBehalfOf = "string",
        TransferData = new Stripe.Inputs.SubscriptionScheduleDefaultSettingsTransferDataArgs
        {
            Destination = "string",
            AmountPercent = 0.0,
        },
    },
    EndBehavior = "string",
    FromSubscription = "string",
    Metadata = 
    {
        { "string", "string" },
    },
    Phases = new[]
    {
        new Stripe.Inputs.SubscriptionSchedulePhaseArgs
        {
            Items = new[]
            {
                new Stripe.Inputs.SubscriptionSchedulePhaseItemArgs
                {
                    BillingThresholds = new Stripe.Inputs.SubscriptionSchedulePhaseItemBillingThresholdsArgs
                    {
                        UsageGte = 0.0,
                    },
                    Discounts = new[]
                    {
                        new Stripe.Inputs.SubscriptionSchedulePhaseItemDiscountArgs
                        {
                            Coupon = "string",
                            Discount = "string",
                            PromotionCode = "string",
                        },
                    },
                    Metadata = 
                    {
                        { "string", "string" },
                    },
                    Plan = "string",
                    Price = "string",
                    PriceData = new Stripe.Inputs.SubscriptionSchedulePhaseItemPriceDataArgs
                    {
                        Currency = "string",
                        Product = "string",
                        Recurring = new Stripe.Inputs.SubscriptionSchedulePhaseItemPriceDataRecurringArgs
                        {
                            Interval = "string",
                            IntervalCount = 0.0,
                        },
                        TaxBehavior = "string",
                        UnitAmount = 0.0,
                        UnitAmountDecimal = 0.0,
                    },
                    Quantity = 0.0,
                    TaxRates = new[]
                    {
                        "string",
                    },
                },
            },
            Discounts = new[]
            {
                new Stripe.Inputs.SubscriptionSchedulePhaseDiscountArgs
                {
                    Coupon = "string",
                    Discount = "string",
                    PromotionCode = "string",
                },
            },
            EndDate = 0.0,
            BillingCycleAnchor = "string",
            BillingThresholds = new Stripe.Inputs.SubscriptionSchedulePhaseBillingThresholdsArgs
            {
                AmountGte = 0.0,
                ResetBillingCycleAnchor = false,
            },
            CollectionMethod = "string",
            Currency = "string",
            DefaultPaymentMethod = "string",
            DefaultTaxRates = new[]
            {
                "string",
            },
            Description = "string",
            AddInvoiceItems = new[]
            {
                new Stripe.Inputs.SubscriptionSchedulePhaseAddInvoiceItemArgs
                {
                    Discountable = false,
                    Discounts = new[]
                    {
                        new Stripe.Inputs.SubscriptionSchedulePhaseAddInvoiceItemDiscountArgs
                        {
                            Coupon = "string",
                            Discount = "string",
                            PromotionCode = "string",
                        },
                    },
                    Metadata = 
                    {
                        { "string", "string" },
                    },
                    Period = new Stripe.Inputs.SubscriptionSchedulePhaseAddInvoiceItemPeriodArgs
                    {
                        End = new Stripe.Inputs.SubscriptionSchedulePhaseAddInvoiceItemPeriodEndArgs
                        {
                            Type = "string",
                            Timestamp = 0.0,
                        },
                        Start = new Stripe.Inputs.SubscriptionSchedulePhaseAddInvoiceItemPeriodStartArgs
                        {
                            Type = "string",
                            Timestamp = 0.0,
                        },
                    },
                    Price = "string",
                    PriceData = new Stripe.Inputs.SubscriptionSchedulePhaseAddInvoiceItemPriceDataArgs
                    {
                        Currency = "string",
                        Product = "string",
                        TaxBehavior = "string",
                        UnitAmount = 0.0,
                        UnitAmountDecimal = 0.0,
                    },
                    Quantity = 0.0,
                    TaxRates = new[]
                    {
                        "string",
                    },
                },
            },
            AutomaticTax = new Stripe.Inputs.SubscriptionSchedulePhaseAutomaticTaxArgs
            {
                Enabled = false,
                DisabledReason = "string",
                Liability = new Stripe.Inputs.SubscriptionSchedulePhaseAutomaticTaxLiabilityArgs
                {
                    Type = "string",
                    Account = "string",
                },
            },
            InvoiceSettings = new Stripe.Inputs.SubscriptionSchedulePhaseInvoiceSettingsArgs
            {
                AccountTaxIds = new[]
                {
                    "string",
                },
                DaysUntilDue = 0.0,
                Issuer = new Stripe.Inputs.SubscriptionSchedulePhaseInvoiceSettingsIssuerArgs
                {
                    Type = "string",
                    Account = "string",
                },
            },
            Duration = new Stripe.Inputs.SubscriptionSchedulePhaseDurationArgs
            {
                Interval = "string",
                IntervalCount = 0.0,
            },
            ApplicationFeePercent = 0.0,
            Metadata = 
            {
                { "string", "string" },
            },
            OnBehalfOf = "string",
            ProrationBehavior = "string",
            StartDate = 0.0,
            TransferData = new Stripe.Inputs.SubscriptionSchedulePhaseTransferDataArgs
            {
                Destination = "string",
                AmountPercent = 0.0,
            },
            Trial = false,
            TrialEnd = 0.0,
        },
    },
    StartDate = 0.0,
});

    example, err := stripe.NewSubscriptionSchedule(ctx, "subscriptionScheduleResource", &stripe.SubscriptionScheduleArgs{
	BillingMode: &stripe.SubscriptionScheduleBillingModeArgs{
		Type: pulumi.String("string"),
		Flexible: &stripe.SubscriptionScheduleBillingModeFlexibleArgs{
			ProrationDiscounts: pulumi.String("string"),
		},
		UpdatedAt: pulumi.Float64(0),
	},
	Customer:        pulumi.String("string"),
	CustomerAccount: pulumi.String("string"),
	DefaultSettings: &stripe.SubscriptionScheduleDefaultSettingsArgs{
		ApplicationFeePercent: pulumi.Float64(0),
		AutomaticTax: &stripe.SubscriptionScheduleDefaultSettingsAutomaticTaxArgs{
			Enabled:        pulumi.Bool(false),
			DisabledReason: pulumi.String("string"),
			Liability: &stripe.SubscriptionScheduleDefaultSettingsAutomaticTaxLiabilityArgs{
				Type:    pulumi.String("string"),
				Account: pulumi.String("string"),
			},
		},
		BillingCycleAnchor: pulumi.String("string"),
		BillingThresholds: &stripe.SubscriptionScheduleDefaultSettingsBillingThresholdsArgs{
			AmountGte:               pulumi.Float64(0),
			ResetBillingCycleAnchor: pulumi.Bool(false),
		},
		CollectionMethod:     pulumi.String("string"),
		DefaultPaymentMethod: pulumi.String("string"),
		Description:          pulumi.String("string"),
		InvoiceSettings: &stripe.SubscriptionScheduleDefaultSettingsInvoiceSettingsArgs{
			AccountTaxIds: pulumi.StringArray{
				pulumi.String("string"),
			},
			DaysUntilDue: pulumi.Float64(0),
			Issuer: &stripe.SubscriptionScheduleDefaultSettingsInvoiceSettingsIssuerArgs{
				Type:    pulumi.String("string"),
				Account: pulumi.String("string"),
			},
		},
		OnBehalfOf: pulumi.String("string"),
		TransferData: &stripe.SubscriptionScheduleDefaultSettingsTransferDataArgs{
			Destination:   pulumi.String("string"),
			AmountPercent: pulumi.Float64(0),
		},
	},
	EndBehavior:      pulumi.String("string"),
	FromSubscription: pulumi.String("string"),
	Metadata: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Phases: stripe.SubscriptionSchedulePhaseArray{
		&stripe.SubscriptionSchedulePhaseArgs{
			Items: stripe.SubscriptionSchedulePhaseItemArray{
				&stripe.SubscriptionSchedulePhaseItemArgs{
					BillingThresholds: &stripe.SubscriptionSchedulePhaseItemBillingThresholdsArgs{
						UsageGte: pulumi.Float64(0),
					},
					Discounts: stripe.SubscriptionSchedulePhaseItemDiscountArray{
						&stripe.SubscriptionSchedulePhaseItemDiscountArgs{
							Coupon:        pulumi.String("string"),
							Discount:      pulumi.String("string"),
							PromotionCode: pulumi.String("string"),
						},
					},
					Metadata: pulumi.StringMap{
						"string": pulumi.String("string"),
					},
					Plan:  pulumi.String("string"),
					Price: pulumi.String("string"),
					PriceData: &stripe.SubscriptionSchedulePhaseItemPriceDataArgs{
						Currency: pulumi.String("string"),
						Product:  pulumi.String("string"),
						Recurring: &stripe.SubscriptionSchedulePhaseItemPriceDataRecurringArgs{
							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"),
					},
				},
			},
			Discounts: stripe.SubscriptionSchedulePhaseDiscountArray{
				&stripe.SubscriptionSchedulePhaseDiscountArgs{
					Coupon:        pulumi.String("string"),
					Discount:      pulumi.String("string"),
					PromotionCode: pulumi.String("string"),
				},
			},
			EndDate:            pulumi.Float64(0),
			BillingCycleAnchor: pulumi.String("string"),
			BillingThresholds: &stripe.SubscriptionSchedulePhaseBillingThresholdsArgs{
				AmountGte:               pulumi.Float64(0),
				ResetBillingCycleAnchor: pulumi.Bool(false),
			},
			CollectionMethod:     pulumi.String("string"),
			Currency:             pulumi.String("string"),
			DefaultPaymentMethod: pulumi.String("string"),
			DefaultTaxRates: pulumi.StringArray{
				pulumi.String("string"),
			},
			Description: pulumi.String("string"),
			AddInvoiceItems: stripe.SubscriptionSchedulePhaseAddInvoiceItemArray{
				&stripe.SubscriptionSchedulePhaseAddInvoiceItemArgs{
					Discountable: pulumi.Bool(false),
					Discounts: stripe.SubscriptionSchedulePhaseAddInvoiceItemDiscountArray{
						&stripe.SubscriptionSchedulePhaseAddInvoiceItemDiscountArgs{
							Coupon:        pulumi.String("string"),
							Discount:      pulumi.String("string"),
							PromotionCode: pulumi.String("string"),
						},
					},
					Metadata: pulumi.StringMap{
						"string": pulumi.String("string"),
					},
					Period: &stripe.SubscriptionSchedulePhaseAddInvoiceItemPeriodArgs{
						End: &stripe.SubscriptionSchedulePhaseAddInvoiceItemPeriodEndArgs{
							Type:      pulumi.String("string"),
							Timestamp: pulumi.Float64(0),
						},
						Start: &stripe.SubscriptionSchedulePhaseAddInvoiceItemPeriodStartArgs{
							Type:      pulumi.String("string"),
							Timestamp: pulumi.Float64(0),
						},
					},
					Price: pulumi.String("string"),
					PriceData: &stripe.SubscriptionSchedulePhaseAddInvoiceItemPriceDataArgs{
						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"),
					},
				},
			},
			AutomaticTax: &stripe.SubscriptionSchedulePhaseAutomaticTaxArgs{
				Enabled:        pulumi.Bool(false),
				DisabledReason: pulumi.String("string"),
				Liability: &stripe.SubscriptionSchedulePhaseAutomaticTaxLiabilityArgs{
					Type:    pulumi.String("string"),
					Account: pulumi.String("string"),
				},
			},
			InvoiceSettings: &stripe.SubscriptionSchedulePhaseInvoiceSettingsArgs{
				AccountTaxIds: pulumi.StringArray{
					pulumi.String("string"),
				},
				DaysUntilDue: pulumi.Float64(0),
				Issuer: &stripe.SubscriptionSchedulePhaseInvoiceSettingsIssuerArgs{
					Type:    pulumi.String("string"),
					Account: pulumi.String("string"),
				},
			},
			Duration: &stripe.SubscriptionSchedulePhaseDurationArgs{
				Interval:      pulumi.String("string"),
				IntervalCount: pulumi.Float64(0),
			},
			ApplicationFeePercent: pulumi.Float64(0),
			Metadata: pulumi.StringMap{
				"string": pulumi.String("string"),
			},
			OnBehalfOf:        pulumi.String("string"),
			ProrationBehavior: pulumi.String("string"),
			StartDate:         pulumi.Float64(0),
			TransferData: &stripe.SubscriptionSchedulePhaseTransferDataArgs{
				Destination:   pulumi.String("string"),
				AmountPercent: pulumi.Float64(0),
			},
			Trial:    pulumi.Bool(false),
			TrialEnd: pulumi.Float64(0),
		},
	},
	StartDate: pulumi.Float64(0),
})

    resource "stripe_subscription_schedule" "subscriptionScheduleResource" {
  lifecycle {
    create_before_destroy = true
  }
  billing_mode = {
    type = "string"
    flexible = {
      proration_discounts = "string"
    }
    updated_at = 0
  }
  customer         = "string"
  customer_account = "string"
  default_settings = {
    application_fee_percent = 0
    automatic_tax = {
      enabled         = false
      disabled_reason = "string"
      liability = {
        type    = "string"
        account = "string"
      }
    }
    billing_cycle_anchor = "string"
    billing_thresholds = {
      amount_gte                 = 0
      reset_billing_cycle_anchor = false
    }
    collection_method      = "string"
    default_payment_method = "string"
    description            = "string"
    invoice_settings = {
      account_tax_ids = ["string"]
      days_until_due  = 0
      issuer = {
        type    = "string"
        account = "string"
      }
    }
    on_behalf_of = "string"
    transfer_data = {
      destination    = "string"
      amount_percent = 0
    }
  }
  end_behavior      = "string"
  from_subscription = "string"
  metadata = {
    "string" = "string"
  }
  phases {
    items {
      billing_thresholds = {
        usage_gte = 0
      }
      discounts {
        coupon         = "string"
        discount       = "string"
        promotion_code = "string"
      }
      metadata = {
        "string" = "string"
      }
      plan  = "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"]
    }
    discounts {
      coupon         = "string"
      discount       = "string"
      promotion_code = "string"
    }
    end_date             = 0
    billing_cycle_anchor = "string"
    billing_thresholds = {
      amount_gte                 = 0
      reset_billing_cycle_anchor = false
    }
    collection_method      = "string"
    currency               = "string"
    default_payment_method = "string"
    default_tax_rates      = ["string"]
    description            = "string"
    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"]
    }
    automatic_tax = {
      enabled         = false
      disabled_reason = "string"
      liability = {
        type    = "string"
        account = "string"
      }
    }
    invoice_settings = {
      account_tax_ids = ["string"]
      days_until_due  = 0
      issuer = {
        type    = "string"
        account = "string"
      }
    }
    duration = {
      interval       = "string"
      interval_count = 0
    }
    application_fee_percent = 0
    metadata = {
      "string" = "string"
    }
    on_behalf_of       = "string"
    proration_behavior = "string"
    start_date         = 0
    transfer_data = {
      destination    = "string"
      amount_percent = 0
    }
    trial     = false
    trial_end = 0
  }
  start_date = 0
}

    var subscriptionScheduleResource = new SubscriptionSchedule("subscriptionScheduleResource", SubscriptionScheduleArgs.builder()
    .billingMode(SubscriptionScheduleBillingModeArgs.builder()
        .type("string")
        .flexible(SubscriptionScheduleBillingModeFlexibleArgs.builder()
            .prorationDiscounts("string")
            .build())
        .updatedAt(0.0)
        .build())
    .customer("string")
    .customerAccount("string")
    .defaultSettings(SubscriptionScheduleDefaultSettingsArgs.builder()
        .applicationFeePercent(0.0)
        .automaticTax(SubscriptionScheduleDefaultSettingsAutomaticTaxArgs.builder()
            .enabled(false)
            .disabledReason("string")
            .liability(SubscriptionScheduleDefaultSettingsAutomaticTaxLiabilityArgs.builder()
                .type("string")
                .account("string")
                .build())
            .build())
        .billingCycleAnchor("string")
        .billingThresholds(SubscriptionScheduleDefaultSettingsBillingThresholdsArgs.builder()
            .amountGte(0.0)
            .resetBillingCycleAnchor(false)
            .build())
        .collectionMethod("string")
        .defaultPaymentMethod("string")
        .description("string")
        .invoiceSettings(SubscriptionScheduleDefaultSettingsInvoiceSettingsArgs.builder()
            .accountTaxIds("string")
            .daysUntilDue(0.0)
            .issuer(SubscriptionScheduleDefaultSettingsInvoiceSettingsIssuerArgs.builder()
                .type("string")
                .account("string")
                .build())
            .build())
        .onBehalfOf("string")
        .transferData(SubscriptionScheduleDefaultSettingsTransferDataArgs.builder()
            .destination("string")
            .amountPercent(0.0)
            .build())
        .build())
    .endBehavior("string")
    .fromSubscription("string")
    .metadata(Map.of("string", "string"))
    .phases(SubscriptionSchedulePhaseArgs.builder()
        .items(SubscriptionSchedulePhaseItemArgs.builder()
            .billingThresholds(SubscriptionSchedulePhaseItemBillingThresholdsArgs.builder()
                .usageGte(0.0)
                .build())
            .discounts(SubscriptionSchedulePhaseItemDiscountArgs.builder()
                .coupon("string")
                .discount("string")
                .promotionCode("string")
                .build())
            .metadata(Map.of("string", "string"))
            .plan("string")
            .price("string")
            .priceData(SubscriptionSchedulePhaseItemPriceDataArgs.builder()
                .currency("string")
                .product("string")
                .recurring(SubscriptionSchedulePhaseItemPriceDataRecurringArgs.builder()
                    .interval("string")
                    .intervalCount(0.0)
                    .build())
                .taxBehavior("string")
                .unitAmount(0.0)
                .unitAmountDecimal(0.0)
                .build())
            .quantity(0.0)
            .taxRates("string")
            .build())
        .discounts(SubscriptionSchedulePhaseDiscountArgs.builder()
            .coupon("string")
            .discount("string")
            .promotionCode("string")
            .build())
        .endDate(0.0)
        .billingCycleAnchor("string")
        .billingThresholds(SubscriptionSchedulePhaseBillingThresholdsArgs.builder()
            .amountGte(0.0)
            .resetBillingCycleAnchor(false)
            .build())
        .collectionMethod("string")
        .currency("string")
        .defaultPaymentMethod("string")
        .defaultTaxRates("string")
        .description("string")
        .addInvoiceItems(SubscriptionSchedulePhaseAddInvoiceItemArgs.builder()
            .discountable(false)
            .discounts(SubscriptionSchedulePhaseAddInvoiceItemDiscountArgs.builder()
                .coupon("string")
                .discount("string")
                .promotionCode("string")
                .build())
            .metadata(Map.of("string", "string"))
            .period(SubscriptionSchedulePhaseAddInvoiceItemPeriodArgs.builder()
                .end(SubscriptionSchedulePhaseAddInvoiceItemPeriodEndArgs.builder()
                    .type("string")
                    .timestamp(0.0)
                    .build())
                .start(SubscriptionSchedulePhaseAddInvoiceItemPeriodStartArgs.builder()
                    .type("string")
                    .timestamp(0.0)
                    .build())
                .build())
            .price("string")
            .priceData(SubscriptionSchedulePhaseAddInvoiceItemPriceDataArgs.builder()
                .currency("string")
                .product("string")
                .taxBehavior("string")
                .unitAmount(0.0)
                .unitAmountDecimal(0.0)
                .build())
            .quantity(0.0)
            .taxRates("string")
            .build())
        .automaticTax(SubscriptionSchedulePhaseAutomaticTaxArgs.builder()
            .enabled(false)
            .disabledReason("string")
            .liability(SubscriptionSchedulePhaseAutomaticTaxLiabilityArgs.builder()
                .type("string")
                .account("string")
                .build())
            .build())
        .invoiceSettings(SubscriptionSchedulePhaseInvoiceSettingsArgs.builder()
            .accountTaxIds("string")
            .daysUntilDue(0.0)
            .issuer(SubscriptionSchedulePhaseInvoiceSettingsIssuerArgs.builder()
                .type("string")
                .account("string")
                .build())
            .build())
        .duration(SubscriptionSchedulePhaseDurationArgs.builder()
            .interval("string")
            .intervalCount(0.0)
            .build())
        .applicationFeePercent(0.0)
        .metadata(Map.of("string", "string"))
        .onBehalfOf("string")
        .prorationBehavior("string")
        .startDate(0.0)
        .transferData(SubscriptionSchedulePhaseTransferDataArgs.builder()
            .destination("string")
            .amountPercent(0.0)
            .build())
        .trial(false)
        .trialEnd(0.0)
        .build())
    .startDate(0.0)
    .build());

    subscription_schedule_resource = stripe.SubscriptionSchedule("subscriptionScheduleResource",
    billing_mode={
        "type": "string",
        "flexible": {
            "proration_discounts": "string",
        },
        "updated_at": float(0),
    },
    customer="string",
    customer_account="string",
    default_settings={
        "application_fee_percent": float(0),
        "automatic_tax": {
            "enabled": False,
            "disabled_reason": "string",
            "liability": {
                "type": "string",
                "account": "string",
            },
        },
        "billing_cycle_anchor": "string",
        "billing_thresholds": {
            "amount_gte": float(0),
            "reset_billing_cycle_anchor": False,
        },
        "collection_method": "string",
        "default_payment_method": "string",
        "description": "string",
        "invoice_settings": {
            "account_tax_ids": ["string"],
            "days_until_due": float(0),
            "issuer": {
                "type": "string",
                "account": "string",
            },
        },
        "on_behalf_of": "string",
        "transfer_data": {
            "destination": "string",
            "amount_percent": float(0),
        },
    },
    end_behavior="string",
    from_subscription="string",
    metadata={
        "string": "string",
    },
    phases=[{
        "items": [{
            "billing_thresholds": {
                "usage_gte": float(0),
            },
            "discounts": [{
                "coupon": "string",
                "discount": "string",
                "promotion_code": "string",
            }],
            "metadata": {
                "string": "string",
            },
            "plan": "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"],
        }],
        "discounts": [{
            "coupon": "string",
            "discount": "string",
            "promotion_code": "string",
        }],
        "end_date": float(0),
        "billing_cycle_anchor": "string",
        "billing_thresholds": {
            "amount_gte": float(0),
            "reset_billing_cycle_anchor": False,
        },
        "collection_method": "string",
        "currency": "string",
        "default_payment_method": "string",
        "default_tax_rates": ["string"],
        "description": "string",
        "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"],
        }],
        "automatic_tax": {
            "enabled": False,
            "disabled_reason": "string",
            "liability": {
                "type": "string",
                "account": "string",
            },
        },
        "invoice_settings": {
            "account_tax_ids": ["string"],
            "days_until_due": float(0),
            "issuer": {
                "type": "string",
                "account": "string",
            },
        },
        "duration": {
            "interval": "string",
            "interval_count": float(0),
        },
        "application_fee_percent": float(0),
        "metadata": {
            "string": "string",
        },
        "on_behalf_of": "string",
        "proration_behavior": "string",
        "start_date": float(0),
        "transfer_data": {
            "destination": "string",
            "amount_percent": float(0),
        },
        "trial": False,
        "trial_end": float(0),
    }],
    start_date=float(0))

    const subscriptionScheduleResource = new stripe.SubscriptionSchedule("subscriptionScheduleResource", {
    billingMode: {
        type: "string",
        flexible: {
            prorationDiscounts: "string",
        },
        updatedAt: 0,
    },
    customer: "string",
    customerAccount: "string",
    defaultSettings: {
        applicationFeePercent: 0,
        automaticTax: {
            enabled: false,
            disabledReason: "string",
            liability: {
                type: "string",
                account: "string",
            },
        },
        billingCycleAnchor: "string",
        billingThresholds: {
            amountGte: 0,
            resetBillingCycleAnchor: false,
        },
        collectionMethod: "string",
        defaultPaymentMethod: "string",
        description: "string",
        invoiceSettings: {
            accountTaxIds: ["string"],
            daysUntilDue: 0,
            issuer: {
                type: "string",
                account: "string",
            },
        },
        onBehalfOf: "string",
        transferData: {
            destination: "string",
            amountPercent: 0,
        },
    },
    endBehavior: "string",
    fromSubscription: "string",
    metadata: {
        string: "string",
    },
    phases: [{
        items: [{
            billingThresholds: {
                usageGte: 0,
            },
            discounts: [{
                coupon: "string",
                discount: "string",
                promotionCode: "string",
            }],
            metadata: {
                string: "string",
            },
            plan: "string",
            price: "string",
            priceData: {
                currency: "string",
                product: "string",
                recurring: {
                    interval: "string",
                    intervalCount: 0,
                },
                taxBehavior: "string",
                unitAmount: 0,
                unitAmountDecimal: 0,
            },
            quantity: 0,
            taxRates: ["string"],
        }],
        discounts: [{
            coupon: "string",
            discount: "string",
            promotionCode: "string",
        }],
        endDate: 0,
        billingCycleAnchor: "string",
        billingThresholds: {
            amountGte: 0,
            resetBillingCycleAnchor: false,
        },
        collectionMethod: "string",
        currency: "string",
        defaultPaymentMethod: "string",
        defaultTaxRates: ["string"],
        description: "string",
        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"],
        }],
        automaticTax: {
            enabled: false,
            disabledReason: "string",
            liability: {
                type: "string",
                account: "string",
            },
        },
        invoiceSettings: {
            accountTaxIds: ["string"],
            daysUntilDue: 0,
            issuer: {
                type: "string",
                account: "string",
            },
        },
        duration: {
            interval: "string",
            intervalCount: 0,
        },
        applicationFeePercent: 0,
        metadata: {
            string: "string",
        },
        onBehalfOf: "string",
        prorationBehavior: "string",
        startDate: 0,
        transferData: {
            destination: "string",
            amountPercent: 0,
        },
        trial: false,
        trialEnd: 0,
    }],
    startDate: 0,
});

    type: stripe:SubscriptionSchedule
properties:
    billingMode:
        flexible:
            prorationDiscounts: string
        type: string
        updatedAt: 0
    customer: string
    customerAccount: string
    defaultSettings:
        applicationFeePercent: 0
        automaticTax:
            disabledReason: string
            enabled: false
            liability:
                account: string
                type: string
        billingCycleAnchor: string
        billingThresholds:
            amountGte: 0
            resetBillingCycleAnchor: false
        collectionMethod: string
        defaultPaymentMethod: string
        description: string
        invoiceSettings:
            accountTaxIds:
                - string
            daysUntilDue: 0
            issuer:
                account: string
                type: string
        onBehalfOf: string
        transferData:
            amountPercent: 0
            destination: string
    endBehavior: string
    fromSubscription: string
    metadata:
        string: string
    phases:
        - 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
          billingCycleAnchor: string
          billingThresholds:
            amountGte: 0
            resetBillingCycleAnchor: false
          collectionMethod: string
          currency: string
          defaultPaymentMethod: string
          defaultTaxRates:
            - string
          description: string
          discounts:
            - coupon: string
              discount: string
              promotionCode: string
          duration:
            interval: string
            intervalCount: 0
          endDate: 0
          invoiceSettings:
            accountTaxIds:
                - string
            daysUntilDue: 0
            issuer:
                account: string
                type: string
          items:
            - billingThresholds:
                usageGte: 0
              discounts:
                - coupon: string
                  discount: string
                  promotionCode: string
              metadata:
                string: string
              plan: 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
          onBehalfOf: string
          prorationBehavior: string
          startDate: 0
          transferData:
            amountPercent: 0
            destination: string
          trial: false
          trialEnd: 0
    startDate: 0

    SubscriptionSchedule 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 SubscriptionSchedule resource accepts the following input properties:

    BillingMode SubscriptionScheduleBillingMode
    The billing mode of the subscription.
    Customer string
    ID of the customer who owns the subscription schedule.
    CustomerAccount string
    ID of the account who owns the subscription schedule.
    DefaultSettings SubscriptionScheduleDefaultSettings
    EndBehavior string
    Behavior of the subscription schedule and underlying subscription when it ends. Possible values are release or cancel with the default being release. release will end the subscription schedule and keep the underlying subscription running. cancel will end the subscription schedule and cancel the underlying subscription.
    FromSubscription string
    Migrate an existing subscription to be managed by a subscription schedule. If this parameter is set, a subscription schedule will be created using the subscription's item(s), set to auto-renew using the subscription's interval. When using this parameter, other parameters (such as phase values) cannot be set. To create a subscription schedule with other modifications, we recommend making two separate API calls.
    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.
    Phases List<SubscriptionSchedulePhase>
    Configuration for the subscription schedule's phases.
    StartDate double
    When the subscription schedule starts. We recommend using now so that it starts the subscription immediately. You can also use a Unix timestamp to backdate the subscription so that it starts on a past date, or set a future date for the subscription to start on.
    BillingMode SubscriptionScheduleBillingModeArgs
    The billing mode of the subscription.
    Customer string
    ID of the customer who owns the subscription schedule.
    CustomerAccount string
    ID of the account who owns the subscription schedule.
    DefaultSettings SubscriptionScheduleDefaultSettingsArgs
    EndBehavior string
    Behavior of the subscription schedule and underlying subscription when it ends. Possible values are release or cancel with the default being release. release will end the subscription schedule and keep the underlying subscription running. cancel will end the subscription schedule and cancel the underlying subscription.
    FromSubscription string
    Migrate an existing subscription to be managed by a subscription schedule. If this parameter is set, a subscription schedule will be created using the subscription's item(s), set to auto-renew using the subscription's interval. When using this parameter, other parameters (such as phase values) cannot be set. To create a subscription schedule with other modifications, we recommend making two separate API calls.
    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.
    Phases []SubscriptionSchedulePhaseArgs
    Configuration for the subscription schedule's phases.
    StartDate float64
    When the subscription schedule starts. We recommend using now so that it starts the subscription immediately. You can also use a Unix timestamp to backdate the subscription so that it starts on a past date, or set a future date for the subscription to start on.
    billing_mode object
    The billing mode of the subscription.
    customer string
    ID of the customer who owns the subscription schedule.
    customer_account string
    ID of the account who owns the subscription schedule.
    default_settings object
    end_behavior string
    Behavior of the subscription schedule and underlying subscription when it ends. Possible values are release or cancel with the default being release. release will end the subscription schedule and keep the underlying subscription running. cancel will end the subscription schedule and cancel the underlying subscription.
    from_subscription string
    Migrate an existing subscription to be managed by a subscription schedule. If this parameter is set, a subscription schedule will be created using the subscription's item(s), set to auto-renew using the subscription's interval. When using this parameter, other parameters (such as phase values) cannot be set. To create a subscription schedule with other modifications, we recommend making two separate API calls.
    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.
    phases list(object)
    Configuration for the subscription schedule's phases.
    start_date number
    When the subscription schedule starts. We recommend using now so that it starts the subscription immediately. You can also use a Unix timestamp to backdate the subscription so that it starts on a past date, or set a future date for the subscription to start on.
    billingMode SubscriptionScheduleBillingMode
    The billing mode of the subscription.
    customer String
    ID of the customer who owns the subscription schedule.
    customerAccount String
    ID of the account who owns the subscription schedule.
    defaultSettings SubscriptionScheduleDefaultSettings
    endBehavior String
    Behavior of the subscription schedule and underlying subscription when it ends. Possible values are release or cancel with the default being release. release will end the subscription schedule and keep the underlying subscription running. cancel will end the subscription schedule and cancel the underlying subscription.
    fromSubscription String
    Migrate an existing subscription to be managed by a subscription schedule. If this parameter is set, a subscription schedule will be created using the subscription's item(s), set to auto-renew using the subscription's interval. When using this parameter, other parameters (such as phase values) cannot be set. To create a subscription schedule with other modifications, we recommend making two separate API calls.
    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.
    phases List<SubscriptionSchedulePhase>
    Configuration for the subscription schedule's phases.
    startDate Double
    When the subscription schedule starts. We recommend using now so that it starts the subscription immediately. You can also use a Unix timestamp to backdate the subscription so that it starts on a past date, or set a future date for the subscription to start on.
    billingMode SubscriptionScheduleBillingMode
    The billing mode of the subscription.
    customer string
    ID of the customer who owns the subscription schedule.
    customerAccount string
    ID of the account who owns the subscription schedule.
    defaultSettings SubscriptionScheduleDefaultSettings
    endBehavior string
    Behavior of the subscription schedule and underlying subscription when it ends. Possible values are release or cancel with the default being release. release will end the subscription schedule and keep the underlying subscription running. cancel will end the subscription schedule and cancel the underlying subscription.
    fromSubscription string
    Migrate an existing subscription to be managed by a subscription schedule. If this parameter is set, a subscription schedule will be created using the subscription's item(s), set to auto-renew using the subscription's interval. When using this parameter, other parameters (such as phase values) cannot be set. To create a subscription schedule with other modifications, we recommend making two separate API calls.
    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.
    phases SubscriptionSchedulePhase[]
    Configuration for the subscription schedule's phases.
    startDate number
    When the subscription schedule starts. We recommend using now so that it starts the subscription immediately. You can also use a Unix timestamp to backdate the subscription so that it starts on a past date, or set a future date for the subscription to start on.
    billing_mode SubscriptionScheduleBillingModeArgs
    The billing mode of the subscription.
    customer str
    ID of the customer who owns the subscription schedule.
    customer_account str
    ID of the account who owns the subscription schedule.
    default_settings SubscriptionScheduleDefaultSettingsArgs
    end_behavior str
    Behavior of the subscription schedule and underlying subscription when it ends. Possible values are release or cancel with the default being release. release will end the subscription schedule and keep the underlying subscription running. cancel will end the subscription schedule and cancel the underlying subscription.
    from_subscription str
    Migrate an existing subscription to be managed by a subscription schedule. If this parameter is set, a subscription schedule will be created using the subscription's item(s), set to auto-renew using the subscription's interval. When using this parameter, other parameters (such as phase values) cannot be set. To create a subscription schedule with other modifications, we recommend making two separate API calls.
    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.
    phases Sequence[SubscriptionSchedulePhaseArgs]
    Configuration for the subscription schedule's phases.
    start_date float
    When the subscription schedule starts. We recommend using now so that it starts the subscription immediately. You can also use a Unix timestamp to backdate the subscription so that it starts on a past date, or set a future date for the subscription to start on.
    billingMode Property Map
    The billing mode of the subscription.
    customer String
    ID of the customer who owns the subscription schedule.
    customerAccount String
    ID of the account who owns the subscription schedule.
    defaultSettings Property Map
    endBehavior String
    Behavior of the subscription schedule and underlying subscription when it ends. Possible values are release or cancel with the default being release. release will end the subscription schedule and keep the underlying subscription running. cancel will end the subscription schedule and cancel the underlying subscription.
    fromSubscription String
    Migrate an existing subscription to be managed by a subscription schedule. If this parameter is set, a subscription schedule will be created using the subscription's item(s), set to auto-renew using the subscription's interval. When using this parameter, other parameters (such as phase values) cannot be set. To create a subscription schedule with other modifications, we recommend making two separate API calls.
    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.
    phases List<Property Map>
    Configuration for the subscription schedule's phases.
    startDate Number
    When the subscription schedule starts. We recommend using now so that it starts the subscription immediately. You can also use a Unix timestamp to backdate the subscription so that it starts on a past date, or set a future date for the subscription to start on.

    Outputs

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

    Application string
    ID of the Connect Application that created the schedule.
    CanceledAt double
    Time at which the subscription schedule was canceled. Measured in seconds since the Unix epoch.
    CompletedAt double
    Time at which the subscription schedule was completed. Measured in seconds since the Unix epoch.
    Created double
    Time at which the object was created. Measured in seconds since the Unix epoch.
    CurrentPhase SubscriptionScheduleCurrentPhase
    Object representing the start and end dates for the current phase of the subscription schedule, if it is active.
    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.
    Object string
    String representing the object's type. Objects of the same type share the same value.
    ReleasedAt double
    Time at which the subscription schedule was released. Measured in seconds since the Unix epoch.
    ReleasedSubscription string
    ID of the subscription once managed by the subscription schedule (if it is released).
    Status string
    The present status of the subscription schedule. Possible values are not_started, active, completed, released, and canceled. You can read more about the different states in our behavior guide.
    Subscription string
    ID of the subscription managed by the subscription schedule.
    TestClock string
    ID of the test clock this subscription schedule belongs to.
    Application string
    ID of the Connect Application that created the schedule.
    CanceledAt float64
    Time at which the subscription schedule was canceled. Measured in seconds since the Unix epoch.
    CompletedAt float64
    Time at which the subscription schedule was completed. Measured in seconds since the Unix epoch.
    Created float64
    Time at which the object was created. Measured in seconds since the Unix epoch.
    CurrentPhase SubscriptionScheduleCurrentPhase
    Object representing the start and end dates for the current phase of the subscription schedule, if it is active.
    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.
    Object string
    String representing the object's type. Objects of the same type share the same value.
    ReleasedAt float64
    Time at which the subscription schedule was released. Measured in seconds since the Unix epoch.
    ReleasedSubscription string
    ID of the subscription once managed by the subscription schedule (if it is released).
    Status string
    The present status of the subscription schedule. Possible values are not_started, active, completed, released, and canceled. You can read more about the different states in our behavior guide.
    Subscription string
    ID of the subscription managed by the subscription schedule.
    TestClock string
    ID of the test clock this subscription schedule belongs to.
    application string
    ID of the Connect Application that created the schedule.
    canceled_at number
    Time at which the subscription schedule was canceled. Measured in seconds since the Unix epoch.
    completed_at number
    Time at which the subscription schedule was completed. Measured in seconds since the Unix epoch.
    created number
    Time at which the object was created. Measured in seconds since the Unix epoch.
    current_phase object
    Object representing the start and end dates for the current phase of the subscription schedule, if it is active.
    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.
    object string
    String representing the object's type. Objects of the same type share the same value.
    released_at number
    Time at which the subscription schedule was released. Measured in seconds since the Unix epoch.
    released_subscription string
    ID of the subscription once managed by the subscription schedule (if it is released).
    status string
    The present status of the subscription schedule. Possible values are not_started, active, completed, released, and canceled. You can read more about the different states in our behavior guide.
    subscription string
    ID of the subscription managed by the subscription schedule.
    test_clock string
    ID of the test clock this subscription schedule belongs to.
    application String
    ID of the Connect Application that created the schedule.
    canceledAt Double
    Time at which the subscription schedule was canceled. Measured in seconds since the Unix epoch.
    completedAt Double
    Time at which the subscription schedule was completed. Measured in seconds since the Unix epoch.
    created Double
    Time at which the object was created. Measured in seconds since the Unix epoch.
    currentPhase SubscriptionScheduleCurrentPhase
    Object representing the start and end dates for the current phase of the subscription schedule, if it is active.
    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.
    object String
    String representing the object's type. Objects of the same type share the same value.
    releasedAt Double
    Time at which the subscription schedule was released. Measured in seconds since the Unix epoch.
    releasedSubscription String
    ID of the subscription once managed by the subscription schedule (if it is released).
    status String
    The present status of the subscription schedule. Possible values are not_started, active, completed, released, and canceled. You can read more about the different states in our behavior guide.
    subscription String
    ID of the subscription managed by the subscription schedule.
    testClock String
    ID of the test clock this subscription schedule belongs to.
    application string
    ID of the Connect Application that created the schedule.
    canceledAt number
    Time at which the subscription schedule was canceled. Measured in seconds since the Unix epoch.
    completedAt number
    Time at which the subscription schedule was completed. Measured in seconds since the Unix epoch.
    created number
    Time at which the object was created. Measured in seconds since the Unix epoch.
    currentPhase SubscriptionScheduleCurrentPhase
    Object representing the start and end dates for the current phase of the subscription schedule, if it is active.
    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.
    object string
    String representing the object's type. Objects of the same type share the same value.
    releasedAt number
    Time at which the subscription schedule was released. Measured in seconds since the Unix epoch.
    releasedSubscription string
    ID of the subscription once managed by the subscription schedule (if it is released).
    status string
    The present status of the subscription schedule. Possible values are not_started, active, completed, released, and canceled. You can read more about the different states in our behavior guide.
    subscription string
    ID of the subscription managed by the subscription schedule.
    testClock string
    ID of the test clock this subscription schedule belongs to.
    application str
    ID of the Connect Application that created the schedule.
    canceled_at float
    Time at which the subscription schedule was canceled. Measured in seconds since the Unix epoch.
    completed_at float
    Time at which the subscription schedule was completed. Measured in seconds since the Unix epoch.
    created float
    Time at which the object was created. Measured in seconds since the Unix epoch.
    current_phase SubscriptionScheduleCurrentPhase
    Object representing the start and end dates for the current phase of the subscription schedule, if it is active.
    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.
    object str
    String representing the object's type. Objects of the same type share the same value.
    released_at float
    Time at which the subscription schedule was released. Measured in seconds since the Unix epoch.
    released_subscription str
    ID of the subscription once managed by the subscription schedule (if it is released).
    status str
    The present status of the subscription schedule. Possible values are not_started, active, completed, released, and canceled. You can read more about the different states in our behavior guide.
    subscription str
    ID of the subscription managed by the subscription schedule.
    test_clock str
    ID of the test clock this subscription schedule belongs to.
    application String
    ID of the Connect Application that created the schedule.
    canceledAt Number
    Time at which the subscription schedule was canceled. Measured in seconds since the Unix epoch.
    completedAt Number
    Time at which the subscription schedule was completed. Measured in seconds since the Unix epoch.
    created Number
    Time at which the object was created. Measured in seconds since the Unix epoch.
    currentPhase Property Map
    Object representing the start and end dates for the current phase of the subscription schedule, if it is active.
    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.
    object String
    String representing the object's type. Objects of the same type share the same value.
    releasedAt Number
    Time at which the subscription schedule was released. Measured in seconds since the Unix epoch.
    releasedSubscription String
    ID of the subscription once managed by the subscription schedule (if it is released).
    status String
    The present status of the subscription schedule. Possible values are not_started, active, completed, released, and canceled. You can read more about the different states in our behavior guide.
    subscription String
    ID of the subscription managed by the subscription schedule.
    testClock String
    ID of the test clock this subscription schedule belongs to.

    Look up Existing SubscriptionSchedule Resource

    Get an existing SubscriptionSchedule 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?: SubscriptionScheduleState, opts?: CustomResourceOptions): SubscriptionSchedule
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        application: Optional[str] = None,
        billing_mode: Optional[SubscriptionScheduleBillingModeArgs] = None,
        canceled_at: Optional[float] = None,
        completed_at: Optional[float] = None,
        created: Optional[float] = None,
        current_phase: Optional[SubscriptionScheduleCurrentPhaseArgs] = None,
        customer: Optional[str] = None,
        customer_account: Optional[str] = None,
        default_settings: Optional[SubscriptionScheduleDefaultSettingsArgs] = None,
        end_behavior: Optional[str] = None,
        from_subscription: Optional[str] = None,
        livemode: Optional[bool] = None,
        metadata: Optional[Mapping[str, str]] = None,
        object: Optional[str] = None,
        phases: Optional[Sequence[SubscriptionSchedulePhaseArgs]] = None,
        released_at: Optional[float] = None,
        released_subscription: Optional[str] = None,
        start_date: Optional[float] = None,
        status: Optional[str] = None,
        subscription: Optional[str] = None,
        test_clock: Optional[str] = None) -> SubscriptionSchedule
    func GetSubscriptionSchedule(ctx *Context, name string, id IDInput, state *SubscriptionScheduleState, opts ...ResourceOption) (*SubscriptionSchedule, error)
    public static SubscriptionSchedule Get(string name, Input<string> id, SubscriptionScheduleState? state, CustomResourceOptions? opts = null)
    public static SubscriptionSchedule get(String name, Output<String> id, SubscriptionScheduleState state, CustomResourceOptions options)
    resources:  _:    type: stripe:SubscriptionSchedule    get:      id: ${id}
    import {
  to = stripe_subscription_schedule.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:
    Application string
    ID of the Connect Application that created the schedule.
    BillingMode SubscriptionScheduleBillingMode
    The billing mode of the subscription.
    CanceledAt double
    Time at which the subscription schedule was canceled. Measured in seconds since the Unix epoch.
    CompletedAt double
    Time at which the subscription schedule was completed. Measured in seconds since the Unix epoch.
    Created double
    Time at which the object was created. Measured in seconds since the Unix epoch.
    CurrentPhase SubscriptionScheduleCurrentPhase
    Object representing the start and end dates for the current phase of the subscription schedule, if it is active.
    Customer string
    ID of the customer who owns the subscription schedule.
    CustomerAccount string
    ID of the account who owns the subscription schedule.
    DefaultSettings SubscriptionScheduleDefaultSettings
    EndBehavior string
    Behavior of the subscription schedule and underlying subscription when it ends. Possible values are release or cancel with the default being release. release will end the subscription schedule and keep the underlying subscription running. cancel will end the subscription schedule and cancel the underlying subscription.
    FromSubscription string
    Migrate an existing subscription to be managed by a subscription schedule. If this parameter is set, a subscription schedule will be created using the subscription's item(s), set to auto-renew using the subscription's interval. When using this parameter, other parameters (such as phase values) cannot be set. To create a subscription schedule with other modifications, we recommend making two separate API calls.
    Livemode bool
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    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.
    Object string
    String representing the object's type. Objects of the same type share the same value.
    Phases List<SubscriptionSchedulePhase>
    Configuration for the subscription schedule's phases.
    ReleasedAt double
    Time at which the subscription schedule was released. Measured in seconds since the Unix epoch.
    ReleasedSubscription string
    ID of the subscription once managed by the subscription schedule (if it is released).
    StartDate double
    When the subscription schedule starts. We recommend using now so that it starts the subscription immediately. You can also use a Unix timestamp to backdate the subscription so that it starts on a past date, or set a future date for the subscription to start on.
    Status string
    The present status of the subscription schedule. Possible values are not_started, active, completed, released, and canceled. You can read more about the different states in our behavior guide.
    Subscription string
    ID of the subscription managed by the subscription schedule.
    TestClock string
    ID of the test clock this subscription schedule belongs to.
    Application string
    ID of the Connect Application that created the schedule.
    BillingMode SubscriptionScheduleBillingModeArgs
    The billing mode of the subscription.
    CanceledAt float64
    Time at which the subscription schedule was canceled. Measured in seconds since the Unix epoch.
    CompletedAt float64
    Time at which the subscription schedule was completed. Measured in seconds since the Unix epoch.
    Created float64
    Time at which the object was created. Measured in seconds since the Unix epoch.
    CurrentPhase SubscriptionScheduleCurrentPhaseArgs
    Object representing the start and end dates for the current phase of the subscription schedule, if it is active.
    Customer string
    ID of the customer who owns the subscription schedule.
    CustomerAccount string
    ID of the account who owns the subscription schedule.
    DefaultSettings SubscriptionScheduleDefaultSettingsArgs
    EndBehavior string
    Behavior of the subscription schedule and underlying subscription when it ends. Possible values are release or cancel with the default being release. release will end the subscription schedule and keep the underlying subscription running. cancel will end the subscription schedule and cancel the underlying subscription.
    FromSubscription string
    Migrate an existing subscription to be managed by a subscription schedule. If this parameter is set, a subscription schedule will be created using the subscription's item(s), set to auto-renew using the subscription's interval. When using this parameter, other parameters (such as phase values) cannot be set. To create a subscription schedule with other modifications, we recommend making two separate API calls.
    Livemode bool
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    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.
    Object string
    String representing the object's type. Objects of the same type share the same value.
    Phases []SubscriptionSchedulePhaseArgs
    Configuration for the subscription schedule's phases.
    ReleasedAt float64
    Time at which the subscription schedule was released. Measured in seconds since the Unix epoch.
    ReleasedSubscription string
    ID of the subscription once managed by the subscription schedule (if it is released).
    StartDate float64
    When the subscription schedule starts. We recommend using now so that it starts the subscription immediately. You can also use a Unix timestamp to backdate the subscription so that it starts on a past date, or set a future date for the subscription to start on.
    Status string
    The present status of the subscription schedule. Possible values are not_started, active, completed, released, and canceled. You can read more about the different states in our behavior guide.
    Subscription string
    ID of the subscription managed by the subscription schedule.
    TestClock string
    ID of the test clock this subscription schedule belongs to.
    application string
    ID of the Connect Application that created the schedule.
    billing_mode object
    The billing mode of the subscription.
    canceled_at number
    Time at which the subscription schedule was canceled. Measured in seconds since the Unix epoch.
    completed_at number
    Time at which the subscription schedule was completed. Measured in seconds since the Unix epoch.
    created number
    Time at which the object was created. Measured in seconds since the Unix epoch.
    current_phase object
    Object representing the start and end dates for the current phase of the subscription schedule, if it is active.
    customer string
    ID of the customer who owns the subscription schedule.
    customer_account string
    ID of the account who owns the subscription schedule.
    default_settings object
    end_behavior string
    Behavior of the subscription schedule and underlying subscription when it ends. Possible values are release or cancel with the default being release. release will end the subscription schedule and keep the underlying subscription running. cancel will end the subscription schedule and cancel the underlying subscription.
    from_subscription string
    Migrate an existing subscription to be managed by a subscription schedule. If this parameter is set, a subscription schedule will be created using the subscription's item(s), set to auto-renew using the subscription's interval. When using this parameter, other parameters (such as phase values) cannot be set. To create a subscription schedule with other modifications, we recommend making two separate API calls.
    livemode bool
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    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.
    object string
    String representing the object's type. Objects of the same type share the same value.
    phases list(object)
    Configuration for the subscription schedule's phases.
    released_at number
    Time at which the subscription schedule was released. Measured in seconds since the Unix epoch.
    released_subscription string
    ID of the subscription once managed by the subscription schedule (if it is released).
    start_date number
    When the subscription schedule starts. We recommend using now so that it starts the subscription immediately. You can also use a Unix timestamp to backdate the subscription so that it starts on a past date, or set a future date for the subscription to start on.
    status string
    The present status of the subscription schedule. Possible values are not_started, active, completed, released, and canceled. You can read more about the different states in our behavior guide.
    subscription string
    ID of the subscription managed by the subscription schedule.
    test_clock string
    ID of the test clock this subscription schedule belongs to.
    application String
    ID of the Connect Application that created the schedule.
    billingMode SubscriptionScheduleBillingMode
    The billing mode of the subscription.
    canceledAt Double
    Time at which the subscription schedule was canceled. Measured in seconds since the Unix epoch.
    completedAt Double
    Time at which the subscription schedule was completed. Measured in seconds since the Unix epoch.
    created Double
    Time at which the object was created. Measured in seconds since the Unix epoch.
    currentPhase SubscriptionScheduleCurrentPhase
    Object representing the start and end dates for the current phase of the subscription schedule, if it is active.
    customer String
    ID of the customer who owns the subscription schedule.
    customerAccount String
    ID of the account who owns the subscription schedule.
    defaultSettings SubscriptionScheduleDefaultSettings
    endBehavior String
    Behavior of the subscription schedule and underlying subscription when it ends. Possible values are release or cancel with the default being release. release will end the subscription schedule and keep the underlying subscription running. cancel will end the subscription schedule and cancel the underlying subscription.
    fromSubscription String
    Migrate an existing subscription to be managed by a subscription schedule. If this parameter is set, a subscription schedule will be created using the subscription's item(s), set to auto-renew using the subscription's interval. When using this parameter, other parameters (such as phase values) cannot be set. To create a subscription schedule with other modifications, we recommend making two separate API calls.
    livemode Boolean
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    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.
    object String
    String representing the object's type. Objects of the same type share the same value.
    phases List<SubscriptionSchedulePhase>
    Configuration for the subscription schedule's phases.
    releasedAt Double
    Time at which the subscription schedule was released. Measured in seconds since the Unix epoch.
    releasedSubscription String
    ID of the subscription once managed by the subscription schedule (if it is released).
    startDate Double
    When the subscription schedule starts. We recommend using now so that it starts the subscription immediately. You can also use a Unix timestamp to backdate the subscription so that it starts on a past date, or set a future date for the subscription to start on.
    status String
    The present status of the subscription schedule. Possible values are not_started, active, completed, released, and canceled. You can read more about the different states in our behavior guide.
    subscription String
    ID of the subscription managed by the subscription schedule.
    testClock String
    ID of the test clock this subscription schedule belongs to.
    application string
    ID of the Connect Application that created the schedule.
    billingMode SubscriptionScheduleBillingMode
    The billing mode of the subscription.
    canceledAt number
    Time at which the subscription schedule was canceled. Measured in seconds since the Unix epoch.
    completedAt number
    Time at which the subscription schedule was completed. Measured in seconds since the Unix epoch.
    created number
    Time at which the object was created. Measured in seconds since the Unix epoch.
    currentPhase SubscriptionScheduleCurrentPhase
    Object representing the start and end dates for the current phase of the subscription schedule, if it is active.
    customer string
    ID of the customer who owns the subscription schedule.
    customerAccount string
    ID of the account who owns the subscription schedule.
    defaultSettings SubscriptionScheduleDefaultSettings
    endBehavior string
    Behavior of the subscription schedule and underlying subscription when it ends. Possible values are release or cancel with the default being release. release will end the subscription schedule and keep the underlying subscription running. cancel will end the subscription schedule and cancel the underlying subscription.
    fromSubscription string
    Migrate an existing subscription to be managed by a subscription schedule. If this parameter is set, a subscription schedule will be created using the subscription's item(s), set to auto-renew using the subscription's interval. When using this parameter, other parameters (such as phase values) cannot be set. To create a subscription schedule with other modifications, we recommend making two separate API calls.
    livemode boolean
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    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.
    object string
    String representing the object's type. Objects of the same type share the same value.
    phases SubscriptionSchedulePhase[]
    Configuration for the subscription schedule's phases.
    releasedAt number
    Time at which the subscription schedule was released. Measured in seconds since the Unix epoch.
    releasedSubscription string
    ID of the subscription once managed by the subscription schedule (if it is released).
    startDate number
    When the subscription schedule starts. We recommend using now so that it starts the subscription immediately. You can also use a Unix timestamp to backdate the subscription so that it starts on a past date, or set a future date for the subscription to start on.
    status string
    The present status of the subscription schedule. Possible values are not_started, active, completed, released, and canceled. You can read more about the different states in our behavior guide.
    subscription string
    ID of the subscription managed by the subscription schedule.
    testClock string
    ID of the test clock this subscription schedule belongs to.
    application str
    ID of the Connect Application that created the schedule.
    billing_mode SubscriptionScheduleBillingModeArgs
    The billing mode of the subscription.
    canceled_at float
    Time at which the subscription schedule was canceled. Measured in seconds since the Unix epoch.
    completed_at float
    Time at which the subscription schedule was completed. Measured in seconds since the Unix epoch.
    created float
    Time at which the object was created. Measured in seconds since the Unix epoch.
    current_phase SubscriptionScheduleCurrentPhaseArgs
    Object representing the start and end dates for the current phase of the subscription schedule, if it is active.
    customer str
    ID of the customer who owns the subscription schedule.
    customer_account str
    ID of the account who owns the subscription schedule.
    default_settings SubscriptionScheduleDefaultSettingsArgs
    end_behavior str
    Behavior of the subscription schedule and underlying subscription when it ends. Possible values are release or cancel with the default being release. release will end the subscription schedule and keep the underlying subscription running. cancel will end the subscription schedule and cancel the underlying subscription.
    from_subscription str
    Migrate an existing subscription to be managed by a subscription schedule. If this parameter is set, a subscription schedule will be created using the subscription's item(s), set to auto-renew using the subscription's interval. When using this parameter, other parameters (such as phase values) cannot be set. To create a subscription schedule with other modifications, we recommend making two separate API calls.
    livemode bool
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    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.
    object str
    String representing the object's type. Objects of the same type share the same value.
    phases Sequence[SubscriptionSchedulePhaseArgs]
    Configuration for the subscription schedule's phases.
    released_at float
    Time at which the subscription schedule was released. Measured in seconds since the Unix epoch.
    released_subscription str
    ID of the subscription once managed by the subscription schedule (if it is released).
    start_date float
    When the subscription schedule starts. We recommend using now so that it starts the subscription immediately. You can also use a Unix timestamp to backdate the subscription so that it starts on a past date, or set a future date for the subscription to start on.
    status str
    The present status of the subscription schedule. Possible values are not_started, active, completed, released, and canceled. You can read more about the different states in our behavior guide.
    subscription str
    ID of the subscription managed by the subscription schedule.
    test_clock str
    ID of the test clock this subscription schedule belongs to.
    application String
    ID of the Connect Application that created the schedule.
    billingMode Property Map
    The billing mode of the subscription.
    canceledAt Number
    Time at which the subscription schedule was canceled. Measured in seconds since the Unix epoch.
    completedAt Number
    Time at which the subscription schedule was completed. Measured in seconds since the Unix epoch.
    created Number
    Time at which the object was created. Measured in seconds since the Unix epoch.
    currentPhase Property Map
    Object representing the start and end dates for the current phase of the subscription schedule, if it is active.
    customer String
    ID of the customer who owns the subscription schedule.
    customerAccount String
    ID of the account who owns the subscription schedule.
    defaultSettings Property Map
    endBehavior String
    Behavior of the subscription schedule and underlying subscription when it ends. Possible values are release or cancel with the default being release. release will end the subscription schedule and keep the underlying subscription running. cancel will end the subscription schedule and cancel the underlying subscription.
    fromSubscription String
    Migrate an existing subscription to be managed by a subscription schedule. If this parameter is set, a subscription schedule will be created using the subscription's item(s), set to auto-renew using the subscription's interval. When using this parameter, other parameters (such as phase values) cannot be set. To create a subscription schedule with other modifications, we recommend making two separate API calls.
    livemode Boolean
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    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.
    object String
    String representing the object's type. Objects of the same type share the same value.
    phases List<Property Map>
    Configuration for the subscription schedule's phases.
    releasedAt Number
    Time at which the subscription schedule was released. Measured in seconds since the Unix epoch.
    releasedSubscription String
    ID of the subscription once managed by the subscription schedule (if it is released).
    startDate Number
    When the subscription schedule starts. We recommend using now so that it starts the subscription immediately. You can also use a Unix timestamp to backdate the subscription so that it starts on a past date, or set a future date for the subscription to start on.
    status String
    The present status of the subscription schedule. Possible values are not_started, active, completed, released, and canceled. You can read more about the different states in our behavior guide.
    subscription String
    ID of the subscription managed by the subscription schedule.
    testClock String
    ID of the test clock this subscription schedule belongs to.

    Supporting Types

    SubscriptionScheduleBillingMode, SubscriptionScheduleBillingModeArgs

    Type string
    Controls how prorations and invoices for subscriptions are calculated and orchestrated.
    Flexible SubscriptionScheduleBillingModeFlexible
    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 SubscriptionScheduleBillingModeFlexible
    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 SubscriptionScheduleBillingModeFlexible
    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 SubscriptionScheduleBillingModeFlexible
    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 SubscriptionScheduleBillingModeFlexible
    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.

    SubscriptionScheduleBillingModeFlexible, SubscriptionScheduleBillingModeFlexibleArgs

    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.

    SubscriptionScheduleCurrentPhase, SubscriptionScheduleCurrentPhaseArgs

    EndDate double
    The end of this phase of the subscription schedule.
    StartDate double
    The start of this phase of the subscription schedule.
    EndDate float64
    The end of this phase of the subscription schedule.
    StartDate float64
    The start of this phase of the subscription schedule.
    end_date number
    The end of this phase of the subscription schedule.
    start_date number
    The start of this phase of the subscription schedule.
    endDate Double
    The end of this phase of the subscription schedule.
    startDate Double
    The start of this phase of the subscription schedule.
    endDate number
    The end of this phase of the subscription schedule.
    startDate number
    The start of this phase of the subscription schedule.
    end_date float
    The end of this phase of the subscription schedule.
    start_date float
    The start of this phase of the subscription schedule.
    endDate Number
    The end of this phase of the subscription schedule.
    startDate Number
    The start of this phase of the subscription schedule.

    SubscriptionScheduleDefaultSettings, SubscriptionScheduleDefaultSettingsArgs

    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 during this phase of the schedule.
    AutomaticTax SubscriptionScheduleDefaultSettingsAutomaticTax
    BillingCycleAnchor string
    Possible values are phase_start or automatic. If phase_start then billing cycle anchor of the subscription is set to the start of the phase when entering the phase. If automatic then the billing cycle anchor is automatically modified as needed when entering the phase. For more information, see the billing cycle documentation.
    BillingThresholds SubscriptionScheduleDefaultSettingsBillingThresholds
    Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period
    CollectionMethod string
    Either charge_automatically, or send_invoice. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing 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.
    DefaultPaymentMethod string
    ID of the default payment method for the subscription schedule. If not set, invoices will use the default payment method in the customer's invoice settings.
    Description string
    Subscription 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.
    InvoiceSettings SubscriptionScheduleDefaultSettingsInvoiceSettings
    OnBehalfOf string
    The account (if any) the charge was made on behalf of for charges associated with the schedule's subscription. See the Connect documentation for details.
    TransferData SubscriptionScheduleDefaultSettingsTransferData
    The account (if any) the associated 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.
    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 during this phase of the schedule.
    AutomaticTax SubscriptionScheduleDefaultSettingsAutomaticTax
    BillingCycleAnchor string
    Possible values are phase_start or automatic. If phase_start then billing cycle anchor of the subscription is set to the start of the phase when entering the phase. If automatic then the billing cycle anchor is automatically modified as needed when entering the phase. For more information, see the billing cycle documentation.
    BillingThresholds SubscriptionScheduleDefaultSettingsBillingThresholds
    Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period
    CollectionMethod string
    Either charge_automatically, or send_invoice. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing 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.
    DefaultPaymentMethod string
    ID of the default payment method for the subscription schedule. If not set, invoices will use the default payment method in the customer's invoice settings.
    Description string
    Subscription 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.
    InvoiceSettings SubscriptionScheduleDefaultSettingsInvoiceSettings
    OnBehalfOf string
    The account (if any) the charge was made on behalf of for charges associated with the schedule's subscription. See the Connect documentation for details.
    TransferData SubscriptionScheduleDefaultSettingsTransferData
    The account (if any) the associated 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.
    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 during this phase of the schedule.
    automatic_tax object
    billing_cycle_anchor string
    Possible values are phase_start or automatic. If phase_start then billing cycle anchor of the subscription is set to the start of the phase when entering the phase. If automatic then the billing cycle anchor is automatically modified as needed when entering the phase. For more information, see the billing cycle documentation.
    billing_thresholds object
    Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period
    collection_method string
    Either charge_automatically, or send_invoice. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing 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.
    default_payment_method string
    ID of the default payment method for the subscription schedule. If not set, invoices will use the default payment method in the customer's invoice settings.
    description string
    Subscription 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.
    invoice_settings object
    on_behalf_of string
    The account (if any) the charge was made on behalf of for charges associated with the schedule's subscription. See the Connect documentation for details.
    transfer_data object
    The account (if any) the associated 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.
    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 during this phase of the schedule.
    automaticTax SubscriptionScheduleDefaultSettingsAutomaticTax
    billingCycleAnchor String
    Possible values are phase_start or automatic. If phase_start then billing cycle anchor of the subscription is set to the start of the phase when entering the phase. If automatic then the billing cycle anchor is automatically modified as needed when entering the phase. For more information, see the billing cycle documentation.
    billingThresholds SubscriptionScheduleDefaultSettingsBillingThresholds
    Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period
    collectionMethod String
    Either charge_automatically, or send_invoice. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing 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.
    defaultPaymentMethod String
    ID of the default payment method for the subscription schedule. If not set, invoices will use the default payment method in the customer's invoice settings.
    description String
    Subscription 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.
    invoiceSettings SubscriptionScheduleDefaultSettingsInvoiceSettings
    onBehalfOf String
    The account (if any) the charge was made on behalf of for charges associated with the schedule's subscription. See the Connect documentation for details.
    transferData SubscriptionScheduleDefaultSettingsTransferData
    The account (if any) the associated 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.
    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 during this phase of the schedule.
    automaticTax SubscriptionScheduleDefaultSettingsAutomaticTax
    billingCycleAnchor string
    Possible values are phase_start or automatic. If phase_start then billing cycle anchor of the subscription is set to the start of the phase when entering the phase. If automatic then the billing cycle anchor is automatically modified as needed when entering the phase. For more information, see the billing cycle documentation.
    billingThresholds SubscriptionScheduleDefaultSettingsBillingThresholds
    Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period
    collectionMethod string
    Either charge_automatically, or send_invoice. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing 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.
    defaultPaymentMethod string
    ID of the default payment method for the subscription schedule. If not set, invoices will use the default payment method in the customer's invoice settings.
    description string
    Subscription 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.
    invoiceSettings SubscriptionScheduleDefaultSettingsInvoiceSettings
    onBehalfOf string
    The account (if any) the charge was made on behalf of for charges associated with the schedule's subscription. See the Connect documentation for details.
    transferData SubscriptionScheduleDefaultSettingsTransferData
    The account (if any) the associated 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.
    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 during this phase of the schedule.
    automatic_tax SubscriptionScheduleDefaultSettingsAutomaticTax
    billing_cycle_anchor str
    Possible values are phase_start or automatic. If phase_start then billing cycle anchor of the subscription is set to the start of the phase when entering the phase. If automatic then the billing cycle anchor is automatically modified as needed when entering the phase. For more information, see the billing cycle documentation.
    billing_thresholds SubscriptionScheduleDefaultSettingsBillingThresholds
    Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period
    collection_method str
    Either charge_automatically, or send_invoice. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing 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.
    default_payment_method str
    ID of the default payment method for the subscription schedule. If not set, invoices will use the default payment method in the customer's invoice settings.
    description str
    Subscription 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.
    invoice_settings SubscriptionScheduleDefaultSettingsInvoiceSettings
    on_behalf_of str
    The account (if any) the charge was made on behalf of for charges associated with the schedule's subscription. See the Connect documentation for details.
    transfer_data SubscriptionScheduleDefaultSettingsTransferData
    The account (if any) the associated 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.
    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 during this phase of the schedule.
    automaticTax Property Map
    billingCycleAnchor String
    Possible values are phase_start or automatic. If phase_start then billing cycle anchor of the subscription is set to the start of the phase when entering the phase. If automatic then the billing cycle anchor is automatically modified as needed when entering the phase. For more information, see the billing cycle documentation.
    billingThresholds Property Map
    Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period
    collectionMethod String
    Either charge_automatically, or send_invoice. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing 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.
    defaultPaymentMethod String
    ID of the default payment method for the subscription schedule. If not set, invoices will use the default payment method in the customer's invoice settings.
    description String
    Subscription 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.
    invoiceSettings Property Map
    onBehalfOf String
    The account (if any) the charge was made on behalf of for charges associated with the schedule's subscription. See the Connect documentation for details.
    transferData Property Map
    The account (if any) the associated 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.

    SubscriptionScheduleDefaultSettingsAutomaticTax, SubscriptionScheduleDefaultSettingsAutomaticTaxArgs

    Enabled bool
    Whether Stripe automatically computes tax on invoices created during this phase.
    DisabledReason string
    If Stripe disabled automatic tax, this enum describes why.
    Liability SubscriptionScheduleDefaultSettingsAutomaticTaxLiability
    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 invoices created during this phase.
    DisabledReason string
    If Stripe disabled automatic tax, this enum describes why.
    Liability SubscriptionScheduleDefaultSettingsAutomaticTaxLiability
    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 invoices created during this phase.
    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 invoices created during this phase.
    disabledReason String
    If Stripe disabled automatic tax, this enum describes why.
    liability SubscriptionScheduleDefaultSettingsAutomaticTaxLiability
    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 invoices created during this phase.
    disabledReason string
    If Stripe disabled automatic tax, this enum describes why.
    liability SubscriptionScheduleDefaultSettingsAutomaticTaxLiability
    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 invoices created during this phase.
    disabled_reason str
    If Stripe disabled automatic tax, this enum describes why.
    liability SubscriptionScheduleDefaultSettingsAutomaticTaxLiability
    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 invoices created during this phase.
    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.

    SubscriptionScheduleDefaultSettingsAutomaticTaxLiability, SubscriptionScheduleDefaultSettingsAutomaticTaxLiabilityArgs

    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.

    SubscriptionScheduleDefaultSettingsBillingThresholds, SubscriptionScheduleDefaultSettingsBillingThresholdsArgs

    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.

    SubscriptionScheduleDefaultSettingsInvoiceSettings, SubscriptionScheduleDefaultSettingsInvoiceSettingsArgs

    AccountTaxIds List<string>
    The account tax IDs associated with the subscription schedule. Will be set on invoices generated by the subscription schedule.
    DaysUntilDue double
    Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be null for subscription schedules where billing=charge_automatically.
    Issuer SubscriptionScheduleDefaultSettingsInvoiceSettingsIssuer
    AccountTaxIds []string
    The account tax IDs associated with the subscription schedule. Will be set on invoices generated by the subscription schedule.
    DaysUntilDue float64
    Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be null for subscription schedules where billing=charge_automatically.
    Issuer SubscriptionScheduleDefaultSettingsInvoiceSettingsIssuer
    account_tax_ids list(string)
    The account tax IDs associated with the subscription schedule. Will be set on invoices generated by the subscription schedule.
    days_until_due number
    Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be null for subscription schedules where billing=charge_automatically.
    issuer object
    accountTaxIds List<String>
    The account tax IDs associated with the subscription schedule. Will be set on invoices generated by the subscription schedule.
    daysUntilDue Double
    Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be null for subscription schedules where billing=charge_automatically.
    issuer SubscriptionScheduleDefaultSettingsInvoiceSettingsIssuer
    accountTaxIds string[]
    The account tax IDs associated with the subscription schedule. Will be set on invoices generated by the subscription schedule.
    daysUntilDue number
    Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be null for subscription schedules where billing=charge_automatically.
    issuer SubscriptionScheduleDefaultSettingsInvoiceSettingsIssuer
    account_tax_ids Sequence[str]
    The account tax IDs associated with the subscription schedule. Will be set on invoices generated by the subscription schedule.
    days_until_due float
    Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be null for subscription schedules where billing=charge_automatically.
    issuer SubscriptionScheduleDefaultSettingsInvoiceSettingsIssuer
    accountTaxIds List<String>
    The account tax IDs associated with the subscription schedule. Will be set on invoices generated by the subscription schedule.
    daysUntilDue Number
    Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be null for subscription schedules where billing=charge_automatically.
    issuer Property Map

    SubscriptionScheduleDefaultSettingsInvoiceSettingsIssuer, SubscriptionScheduleDefaultSettingsInvoiceSettingsIssuerArgs

    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.

    SubscriptionScheduleDefaultSettingsTransferData, SubscriptionScheduleDefaultSettingsTransferDataArgs

    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.

    SubscriptionSchedulePhase, SubscriptionSchedulePhaseArgs

    Items List<SubscriptionSchedulePhaseItem>
    Subscription items to configure the subscription to during this phase of the subscription schedule.
    AddInvoiceItems List<SubscriptionSchedulePhaseAddInvoiceItem>
    A list of prices and quantities that will generate invoice items appended to the next invoice for this phase.
    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 during this phase of the schedule.
    AutomaticTax SubscriptionSchedulePhaseAutomaticTax
    BillingCycleAnchor string
    Possible values are phase_start or automatic. If phase_start then billing cycle anchor of the subscription is set to the start of the phase when entering the phase. If automatic then the billing cycle anchor is automatically modified as needed when entering the phase. For more information, see the billing cycle documentation.
    BillingThresholds SubscriptionSchedulePhaseBillingThresholds
    Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period
    CollectionMethod string
    Either charge_automatically, or send_invoice. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing 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.
    DefaultPaymentMethod string
    ID of the default payment method for the subscription schedule. It must belong to the customer associated with the subscription schedule. If not set, invoices will use the default payment method in the customer's invoice settings.
    DefaultTaxRates List<string>
    The default tax rates to apply to the subscription during this phase of the subscription schedule.
    Description string
    Subscription 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<SubscriptionSchedulePhaseDiscount>
    The stackable discounts that will be applied to the subscription on this phase. Subscription item discounts are applied before subscription discounts.
    Duration SubscriptionSchedulePhaseDuration
    The number of intervals the phase should last. If set, end_date must not be set.
    EndDate double
    The end of this phase of the subscription schedule.
    InvoiceSettings SubscriptionSchedulePhaseInvoiceSettings
    The invoice settings applicable during this phase.
    Metadata Dictionary<string, string>
    Set of key-value pairs that you can attach to a phase. Metadata on a schedule's phase will update the underlying subscription's metadata when the phase is entered. Updating the underlying subscription's metadata directly will not affect the current phase's metadata.
    OnBehalfOf string
    The account (if any) the charge was made on behalf of for charges associated with the schedule's subscription. See the Connect documentation for details.
    ProrationBehavior string
    When transitioning phases, controls how prorations are handled (if any). Possible values are create_prorations, none, and always_invoice.
    StartDate double
    The start of this phase of the subscription schedule.
    TransferData SubscriptionSchedulePhaseTransferData
    The account (if any) the associated 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 bool
    If set to true the entire phase is counted as a trial and the customer will not be charged for any fees.
    TrialEnd double
    When the trial ends within the phase.
    Items []SubscriptionSchedulePhaseItem
    Subscription items to configure the subscription to during this phase of the subscription schedule.
    AddInvoiceItems []SubscriptionSchedulePhaseAddInvoiceItem
    A list of prices and quantities that will generate invoice items appended to the next invoice for this phase.
    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 during this phase of the schedule.
    AutomaticTax SubscriptionSchedulePhaseAutomaticTax
    BillingCycleAnchor string
    Possible values are phase_start or automatic. If phase_start then billing cycle anchor of the subscription is set to the start of the phase when entering the phase. If automatic then the billing cycle anchor is automatically modified as needed when entering the phase. For more information, see the billing cycle documentation.
    BillingThresholds SubscriptionSchedulePhaseBillingThresholds
    Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period
    CollectionMethod string
    Either charge_automatically, or send_invoice. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing 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.
    DefaultPaymentMethod string
    ID of the default payment method for the subscription schedule. It must belong to the customer associated with the subscription schedule. If not set, invoices will use the default payment method in the customer's invoice settings.
    DefaultTaxRates []string
    The default tax rates to apply to the subscription during this phase of the subscription schedule.
    Description string
    Subscription 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 []SubscriptionSchedulePhaseDiscount
    The stackable discounts that will be applied to the subscription on this phase. Subscription item discounts are applied before subscription discounts.
    Duration SubscriptionSchedulePhaseDuration
    The number of intervals the phase should last. If set, end_date must not be set.
    EndDate float64
    The end of this phase of the subscription schedule.
    InvoiceSettings SubscriptionSchedulePhaseInvoiceSettings
    The invoice settings applicable during this phase.
    Metadata map[string]string
    Set of key-value pairs that you can attach to a phase. Metadata on a schedule's phase will update the underlying subscription's metadata when the phase is entered. Updating the underlying subscription's metadata directly will not affect the current phase's metadata.
    OnBehalfOf string
    The account (if any) the charge was made on behalf of for charges associated with the schedule's subscription. See the Connect documentation for details.
    ProrationBehavior string
    When transitioning phases, controls how prorations are handled (if any). Possible values are create_prorations, none, and always_invoice.
    StartDate float64
    The start of this phase of the subscription schedule.
    TransferData SubscriptionSchedulePhaseTransferData
    The account (if any) the associated 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 bool
    If set to true the entire phase is counted as a trial and the customer will not be charged for any fees.
    TrialEnd float64
    When the trial ends within the phase.
    items list(object)
    Subscription items to configure the subscription to during this phase of the subscription schedule.
    add_invoice_items list(object)
    A list of prices and quantities that will generate invoice items appended to the next invoice for this phase.
    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 during this phase of the schedule.
    automatic_tax object
    billing_cycle_anchor string
    Possible values are phase_start or automatic. If phase_start then billing cycle anchor of the subscription is set to the start of the phase when entering the phase. If automatic then the billing cycle anchor is automatically modified as needed when entering the phase. For more information, see the billing cycle documentation.
    billing_thresholds object
    Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period
    collection_method string
    Either charge_automatically, or send_invoice. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing 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.
    default_payment_method string
    ID of the default payment method for the subscription schedule. It must belong to the customer associated with the subscription schedule. If not set, invoices will use the default payment method in the customer's invoice settings.
    default_tax_rates list(string)
    The default tax rates to apply to the subscription during this phase of the subscription schedule.
    description string
    Subscription 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 stackable discounts that will be applied to the subscription on this phase. Subscription item discounts are applied before subscription discounts.
    duration object
    The number of intervals the phase should last. If set, end_date must not be set.
    end_date number
    The end of this phase of the subscription schedule.
    invoice_settings object
    The invoice settings applicable during this phase.
    metadata map(string)
    Set of key-value pairs that you can attach to a phase. Metadata on a schedule's phase will update the underlying subscription's metadata when the phase is entered. Updating the underlying subscription's metadata directly will not affect the current phase's metadata.
    on_behalf_of string
    The account (if any) the charge was made on behalf of for charges associated with the schedule's subscription. See the Connect documentation for details.
    proration_behavior string
    When transitioning phases, controls how prorations are handled (if any). Possible values are create_prorations, none, and always_invoice.
    start_date number
    The start of this phase of the subscription schedule.
    transfer_data object
    The account (if any) the associated 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 bool
    If set to true the entire phase is counted as a trial and the customer will not be charged for any fees.
    trial_end number
    When the trial ends within the phase.
    items List<SubscriptionSchedulePhaseItem>
    Subscription items to configure the subscription to during this phase of the subscription schedule.
    addInvoiceItems List<SubscriptionSchedulePhaseAddInvoiceItem>
    A list of prices and quantities that will generate invoice items appended to the next invoice for this phase.
    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 during this phase of the schedule.
    automaticTax SubscriptionSchedulePhaseAutomaticTax
    billingCycleAnchor String
    Possible values are phase_start or automatic. If phase_start then billing cycle anchor of the subscription is set to the start of the phase when entering the phase. If automatic then the billing cycle anchor is automatically modified as needed when entering the phase. For more information, see the billing cycle documentation.
    billingThresholds SubscriptionSchedulePhaseBillingThresholds
    Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period
    collectionMethod String
    Either charge_automatically, or send_invoice. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing 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.
    defaultPaymentMethod String
    ID of the default payment method for the subscription schedule. It must belong to the customer associated with the subscription schedule. If not set, invoices will use the default payment method in the customer's invoice settings.
    defaultTaxRates List<String>
    The default tax rates to apply to the subscription during this phase of the subscription schedule.
    description String
    Subscription 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<SubscriptionSchedulePhaseDiscount>
    The stackable discounts that will be applied to the subscription on this phase. Subscription item discounts are applied before subscription discounts.
    duration SubscriptionSchedulePhaseDuration
    The number of intervals the phase should last. If set, end_date must not be set.
    endDate Double
    The end of this phase of the subscription schedule.
    invoiceSettings SubscriptionSchedulePhaseInvoiceSettings
    The invoice settings applicable during this phase.
    metadata Map<String,String>
    Set of key-value pairs that you can attach to a phase. Metadata on a schedule's phase will update the underlying subscription's metadata when the phase is entered. Updating the underlying subscription's metadata directly will not affect the current phase's metadata.
    onBehalfOf String
    The account (if any) the charge was made on behalf of for charges associated with the schedule's subscription. See the Connect documentation for details.
    prorationBehavior String
    When transitioning phases, controls how prorations are handled (if any). Possible values are create_prorations, none, and always_invoice.
    startDate Double
    The start of this phase of the subscription schedule.
    transferData SubscriptionSchedulePhaseTransferData
    The account (if any) the associated 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 Boolean
    If set to true the entire phase is counted as a trial and the customer will not be charged for any fees.
    trialEnd Double
    When the trial ends within the phase.
    items SubscriptionSchedulePhaseItem[]
    Subscription items to configure the subscription to during this phase of the subscription schedule.
    addInvoiceItems SubscriptionSchedulePhaseAddInvoiceItem[]
    A list of prices and quantities that will generate invoice items appended to the next invoice for this phase.
    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 during this phase of the schedule.
    automaticTax SubscriptionSchedulePhaseAutomaticTax
    billingCycleAnchor string
    Possible values are phase_start or automatic. If phase_start then billing cycle anchor of the subscription is set to the start of the phase when entering the phase. If automatic then the billing cycle anchor is automatically modified as needed when entering the phase. For more information, see the billing cycle documentation.
    billingThresholds SubscriptionSchedulePhaseBillingThresholds
    Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period
    collectionMethod string
    Either charge_automatically, or send_invoice. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing 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.
    defaultPaymentMethod string
    ID of the default payment method for the subscription schedule. It must belong to the customer associated with the subscription schedule. If not set, invoices will use the default payment method in the customer's invoice settings.
    defaultTaxRates string[]
    The default tax rates to apply to the subscription during this phase of the subscription schedule.
    description string
    Subscription 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 SubscriptionSchedulePhaseDiscount[]
    The stackable discounts that will be applied to the subscription on this phase. Subscription item discounts are applied before subscription discounts.
    duration SubscriptionSchedulePhaseDuration
    The number of intervals the phase should last. If set, end_date must not be set.
    endDate number
    The end of this phase of the subscription schedule.
    invoiceSettings SubscriptionSchedulePhaseInvoiceSettings
    The invoice settings applicable during this phase.
    metadata {[key: string]: string}
    Set of key-value pairs that you can attach to a phase. Metadata on a schedule's phase will update the underlying subscription's metadata when the phase is entered. Updating the underlying subscription's metadata directly will not affect the current phase's metadata.
    onBehalfOf string
    The account (if any) the charge was made on behalf of for charges associated with the schedule's subscription. See the Connect documentation for details.
    prorationBehavior string
    When transitioning phases, controls how prorations are handled (if any). Possible values are create_prorations, none, and always_invoice.
    startDate number
    The start of this phase of the subscription schedule.
    transferData SubscriptionSchedulePhaseTransferData
    The account (if any) the associated 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 boolean
    If set to true the entire phase is counted as a trial and the customer will not be charged for any fees.
    trialEnd number
    When the trial ends within the phase.
    items Sequence[SubscriptionSchedulePhaseItem]
    Subscription items to configure the subscription to during this phase of the subscription schedule.
    add_invoice_items Sequence[SubscriptionSchedulePhaseAddInvoiceItem]
    A list of prices and quantities that will generate invoice items appended to the next invoice for this phase.
    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 during this phase of the schedule.
    automatic_tax SubscriptionSchedulePhaseAutomaticTax
    billing_cycle_anchor str
    Possible values are phase_start or automatic. If phase_start then billing cycle anchor of the subscription is set to the start of the phase when entering the phase. If automatic then the billing cycle anchor is automatically modified as needed when entering the phase. For more information, see the billing cycle documentation.
    billing_thresholds SubscriptionSchedulePhaseBillingThresholds
    Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period
    collection_method str
    Either charge_automatically, or send_invoice. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing 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.
    default_payment_method str
    ID of the default payment method for the subscription schedule. It must belong to the customer associated with the subscription schedule. If not set, invoices will use the default payment method in the customer's invoice settings.
    default_tax_rates Sequence[str]
    The default tax rates to apply to the subscription during this phase of the subscription schedule.
    description str
    Subscription 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[SubscriptionSchedulePhaseDiscount]
    The stackable discounts that will be applied to the subscription on this phase. Subscription item discounts are applied before subscription discounts.
    duration SubscriptionSchedulePhaseDuration
    The number of intervals the phase should last. If set, end_date must not be set.
    end_date float
    The end of this phase of the subscription schedule.
    invoice_settings SubscriptionSchedulePhaseInvoiceSettings
    The invoice settings applicable during this phase.
    metadata Mapping[str, str]
    Set of key-value pairs that you can attach to a phase. Metadata on a schedule's phase will update the underlying subscription's metadata when the phase is entered. Updating the underlying subscription's metadata directly will not affect the current phase's metadata.
    on_behalf_of str
    The account (if any) the charge was made on behalf of for charges associated with the schedule's subscription. See the Connect documentation for details.
    proration_behavior str
    When transitioning phases, controls how prorations are handled (if any). Possible values are create_prorations, none, and always_invoice.
    start_date float
    The start of this phase of the subscription schedule.
    transfer_data SubscriptionSchedulePhaseTransferData
    The account (if any) the associated 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 bool
    If set to true the entire phase is counted as a trial and the customer will not be charged for any fees.
    trial_end float
    When the trial ends within the phase.
    items List<Property Map>
    Subscription items to configure the subscription to during this phase of the subscription schedule.
    addInvoiceItems List<Property Map>
    A list of prices and quantities that will generate invoice items appended to the next invoice for this phase.
    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 during this phase of the schedule.
    automaticTax Property Map
    billingCycleAnchor String
    Possible values are phase_start or automatic. If phase_start then billing cycle anchor of the subscription is set to the start of the phase when entering the phase. If automatic then the billing cycle anchor is automatically modified as needed when entering the phase. For more information, see the billing cycle documentation.
    billingThresholds Property Map
    Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period
    collectionMethod String
    Either charge_automatically, or send_invoice. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing 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.
    defaultPaymentMethod String
    ID of the default payment method for the subscription schedule. It must belong to the customer associated with the subscription schedule. If not set, invoices will use the default payment method in the customer's invoice settings.
    defaultTaxRates List<String>
    The default tax rates to apply to the subscription during this phase of the subscription schedule.
    description String
    Subscription 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 stackable discounts that will be applied to the subscription on this phase. Subscription item discounts are applied before subscription discounts.
    duration Property Map
    The number of intervals the phase should last. If set, end_date must not be set.
    endDate Number
    The end of this phase of the subscription schedule.
    invoiceSettings Property Map
    The invoice settings applicable during this phase.
    metadata Map<String>
    Set of key-value pairs that you can attach to a phase. Metadata on a schedule's phase will update the underlying subscription's metadata when the phase is entered. Updating the underlying subscription's metadata directly will not affect the current phase's metadata.
    onBehalfOf String
    The account (if any) the charge was made on behalf of for charges associated with the schedule's subscription. See the Connect documentation for details.
    prorationBehavior String
    When transitioning phases, controls how prorations are handled (if any). Possible values are create_prorations, none, and always_invoice.
    startDate Number
    The start of this phase of the subscription schedule.
    transferData Property Map
    The account (if any) the associated 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 Boolean
    If set to true the entire phase is counted as a trial and the customer will not be charged for any fees.
    trialEnd Number
    When the trial ends within the phase.

    SubscriptionSchedulePhaseAddInvoiceItem, SubscriptionSchedulePhaseAddInvoiceItemArgs

    Discountable bool
    Controls whether discounts apply to this invoice item. Defaults to true if no value is provided.
    Discounts List<SubscriptionSchedulePhaseAddInvoiceItemDiscount>
    The stackable discounts that will be applied to 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.
    Period SubscriptionSchedulePhaseAddInvoiceItemPeriod
    Price string
    ID of the price used to generate the invoice item.
    PriceData SubscriptionSchedulePhaseAddInvoiceItemPriceData
    Data used to generate a new Price object inline. One of price or price_data is required.
    Quantity double
    The quantity of the invoice item.
    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 []SubscriptionSchedulePhaseAddInvoiceItemDiscount
    The stackable discounts that will be applied to 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.
    Period SubscriptionSchedulePhaseAddInvoiceItemPeriod
    Price string
    ID of the price used to generate the invoice item.
    PriceData SubscriptionSchedulePhaseAddInvoiceItemPriceData
    Data used to generate a new Price object inline. One of price or price_data is required.
    Quantity float64
    The quantity of the invoice item.
    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 stackable discounts that will be applied to 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.
    period object
    price string
    ID of the price used to generate the invoice item.
    price_data object
    Data used to generate a new Price object inline. One of price or price_data is required.
    quantity number
    The quantity of the invoice item.
    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<SubscriptionSchedulePhaseAddInvoiceItemDiscount>
    The stackable discounts that will be applied to 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.
    period SubscriptionSchedulePhaseAddInvoiceItemPeriod
    price String
    ID of the price used to generate the invoice item.
    priceData SubscriptionSchedulePhaseAddInvoiceItemPriceData
    Data used to generate a new Price object inline. One of price or price_data is required.
    quantity Double
    The quantity of the invoice item.
    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 SubscriptionSchedulePhaseAddInvoiceItemDiscount[]
    The stackable discounts that will be applied to 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.
    period SubscriptionSchedulePhaseAddInvoiceItemPeriod
    price string
    ID of the price used to generate the invoice item.
    priceData SubscriptionSchedulePhaseAddInvoiceItemPriceData
    Data used to generate a new Price object inline. One of price or price_data is required.
    quantity number
    The quantity of the invoice item.
    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[SubscriptionSchedulePhaseAddInvoiceItemDiscount]
    The stackable discounts that will be applied to 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.
    period SubscriptionSchedulePhaseAddInvoiceItemPeriod
    price str
    ID of the price used to generate the invoice item.
    price_data SubscriptionSchedulePhaseAddInvoiceItemPriceData
    Data used to generate a new Price object inline. One of price or price_data is required.
    quantity float
    The quantity of the invoice item.
    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 stackable discounts that will be applied to 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.
    period Property Map
    price String
    ID of the price used to generate the invoice item.
    priceData Property Map
    Data used to generate a new Price object inline. One of price or price_data is required.
    quantity Number
    The quantity of the invoice item.
    taxRates List<String>
    The tax rates which apply to the item. When set, the default_tax_rates do not apply to this item.

    SubscriptionSchedulePhaseAddInvoiceItemDiscount, SubscriptionSchedulePhaseAddInvoiceItemDiscountArgs

    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.

    SubscriptionSchedulePhaseAddInvoiceItemPeriod, SubscriptionSchedulePhaseAddInvoiceItemPeriodArgs

    SubscriptionSchedulePhaseAddInvoiceItemPeriodEnd, SubscriptionSchedulePhaseAddInvoiceItemPeriodEndArgs

    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.

    SubscriptionSchedulePhaseAddInvoiceItemPeriodStart, SubscriptionSchedulePhaseAddInvoiceItemPeriodStartArgs

    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.

    SubscriptionSchedulePhaseAddInvoiceItemPriceData, SubscriptionSchedulePhaseAddInvoiceItemPriceDataArgs

    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.

    SubscriptionSchedulePhaseAutomaticTax, SubscriptionSchedulePhaseAutomaticTaxArgs

    Enabled bool
    Whether Stripe automatically computes tax on invoices created during this phase.
    DisabledReason string
    If Stripe disabled automatic tax, this enum describes why.
    Liability SubscriptionSchedulePhaseAutomaticTaxLiability
    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 invoices created during this phase.
    DisabledReason string
    If Stripe disabled automatic tax, this enum describes why.
    Liability SubscriptionSchedulePhaseAutomaticTaxLiability
    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 invoices created during this phase.
    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 invoices created during this phase.
    disabledReason String
    If Stripe disabled automatic tax, this enum describes why.
    liability SubscriptionSchedulePhaseAutomaticTaxLiability
    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 invoices created during this phase.
    disabledReason string
    If Stripe disabled automatic tax, this enum describes why.
    liability SubscriptionSchedulePhaseAutomaticTaxLiability
    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 invoices created during this phase.
    disabled_reason str
    If Stripe disabled automatic tax, this enum describes why.
    liability SubscriptionSchedulePhaseAutomaticTaxLiability
    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 invoices created during this phase.
    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.

    SubscriptionSchedulePhaseAutomaticTaxLiability, SubscriptionSchedulePhaseAutomaticTaxLiabilityArgs

    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.

    SubscriptionSchedulePhaseBillingThresholds, SubscriptionSchedulePhaseBillingThresholdsArgs

    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.

    SubscriptionSchedulePhaseDiscount, SubscriptionSchedulePhaseDiscountArgs

    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.

    SubscriptionSchedulePhaseDuration, SubscriptionSchedulePhaseDurationArgs

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

    SubscriptionSchedulePhaseInvoiceSettings, SubscriptionSchedulePhaseInvoiceSettingsArgs

    AccountTaxIds List<string>
    The account tax IDs associated with this phase of the subscription schedule. Will be set on invoices generated by this phase of the subscription schedule.
    DaysUntilDue double
    Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be null for subscription schedules where billing=charge_automatically.
    Issuer SubscriptionSchedulePhaseInvoiceSettingsIssuer
    The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
    AccountTaxIds []string
    The account tax IDs associated with this phase of the subscription schedule. Will be set on invoices generated by this phase of the subscription schedule.
    DaysUntilDue float64
    Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be null for subscription schedules where billing=charge_automatically.
    Issuer SubscriptionSchedulePhaseInvoiceSettingsIssuer
    The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
    account_tax_ids list(string)
    The account tax IDs associated with this phase of the subscription schedule. Will be set on invoices generated by this phase of the subscription schedule.
    days_until_due number
    Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be null for subscription schedules where billing=charge_automatically.
    issuer object
    The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
    accountTaxIds List<String>
    The account tax IDs associated with this phase of the subscription schedule. Will be set on invoices generated by this phase of the subscription schedule.
    daysUntilDue Double
    Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be null for subscription schedules where billing=charge_automatically.
    issuer SubscriptionSchedulePhaseInvoiceSettingsIssuer
    The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
    accountTaxIds string[]
    The account tax IDs associated with this phase of the subscription schedule. Will be set on invoices generated by this phase of the subscription schedule.
    daysUntilDue number
    Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be null for subscription schedules where billing=charge_automatically.
    issuer SubscriptionSchedulePhaseInvoiceSettingsIssuer
    The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
    account_tax_ids Sequence[str]
    The account tax IDs associated with this phase of the subscription schedule. Will be set on invoices generated by this phase of the subscription schedule.
    days_until_due float
    Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be null for subscription schedules where billing=charge_automatically.
    issuer SubscriptionSchedulePhaseInvoiceSettingsIssuer
    The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
    accountTaxIds List<String>
    The account tax IDs associated with this phase of the subscription schedule. Will be set on invoices generated by this phase of the subscription schedule.
    daysUntilDue Number
    Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be null for subscription schedules where billing=charge_automatically.
    issuer Property Map
    The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.

    SubscriptionSchedulePhaseInvoiceSettingsIssuer, SubscriptionSchedulePhaseInvoiceSettingsIssuerArgs

    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.

    SubscriptionSchedulePhaseItem, SubscriptionSchedulePhaseItemArgs

    BillingThresholds SubscriptionSchedulePhaseItemBillingThresholds
    Define thresholds at which an invoice will be sent, and the related subscription advanced to a new billing period
    Discounts List<SubscriptionSchedulePhaseItemDiscount>
    The discounts applied to the subscription item. Subscription item discounts are applied before subscription discounts. Use expand[]=discounts to expand each discount.
    Metadata Dictionary<string, string>
    Set of key-value pairs that you can attach to an item. Metadata on this item will update the underlying subscription item's metadata when the phase is entered.
    Plan string
    ID of the plan to which the customer should be subscribed.
    Price string
    ID of the price to which the customer should be subscribed.
    PriceData SubscriptionSchedulePhaseItemPriceData
    Data used to generate a new Price object inline.
    Quantity double
    Quantity of the plan to which the customer should be subscribed.
    TaxRates List<string>
    The tax rates which apply to this phase_item. When set, the default_tax_rates on the phase do not apply to this phase_item.
    BillingThresholds SubscriptionSchedulePhaseItemBillingThresholds
    Define thresholds at which an invoice will be sent, and the related subscription advanced to a new billing period
    Discounts []SubscriptionSchedulePhaseItemDiscount
    The discounts applied to the subscription item. Subscription item discounts are applied before subscription discounts. Use expand[]=discounts to expand each discount.
    Metadata map[string]string
    Set of key-value pairs that you can attach to an item. Metadata on this item will update the underlying subscription item's metadata when the phase is entered.
    Plan string
    ID of the plan to which the customer should be subscribed.
    Price string
    ID of the price to which the customer should be subscribed.
    PriceData SubscriptionSchedulePhaseItemPriceData
    Data used to generate a new Price object inline.
    Quantity float64
    Quantity of the plan to which the customer should be subscribed.
    TaxRates []string
    The tax rates which apply to this phase_item. When set, the default_tax_rates on the phase do not apply to this phase_item.
    billing_thresholds object
    Define thresholds at which an invoice will be sent, and the related subscription advanced to a new billing period
    discounts list(object)
    The discounts applied to the subscription item. Subscription item discounts are applied before subscription discounts. Use expand[]=discounts to expand each discount.
    metadata map(string)
    Set of key-value pairs that you can attach to an item. Metadata on this item will update the underlying subscription item's metadata when the phase is entered.
    plan string
    ID of the plan to which the customer should be subscribed.
    price string
    ID of the price to which the customer should be subscribed.
    price_data object
    Data used to generate a new Price object inline.
    quantity number
    Quantity of the plan to which the customer should be subscribed.
    tax_rates list(string)
    The tax rates which apply to this phase_item. When set, the default_tax_rates on the phase do not apply to this phase_item.
    billingThresholds SubscriptionSchedulePhaseItemBillingThresholds
    Define thresholds at which an invoice will be sent, and the related subscription advanced to a new billing period
    discounts List<SubscriptionSchedulePhaseItemDiscount>
    The discounts applied to the subscription item. Subscription item discounts are applied before subscription discounts. Use expand[]=discounts to expand each discount.
    metadata Map<String,String>
    Set of key-value pairs that you can attach to an item. Metadata on this item will update the underlying subscription item's metadata when the phase is entered.
    plan String
    ID of the plan to which the customer should be subscribed.
    price String
    ID of the price to which the customer should be subscribed.
    priceData SubscriptionSchedulePhaseItemPriceData
    Data used to generate a new Price object inline.
    quantity Double
    Quantity of the plan to which the customer should be subscribed.
    taxRates List<String>
    The tax rates which apply to this phase_item. When set, the default_tax_rates on the phase do not apply to this phase_item.
    billingThresholds SubscriptionSchedulePhaseItemBillingThresholds
    Define thresholds at which an invoice will be sent, and the related subscription advanced to a new billing period
    discounts SubscriptionSchedulePhaseItemDiscount[]
    The discounts applied to the subscription item. Subscription item discounts are applied before subscription discounts. Use expand[]=discounts to expand each discount.
    metadata {[key: string]: string}
    Set of key-value pairs that you can attach to an item. Metadata on this item will update the underlying subscription item's metadata when the phase is entered.
    plan string
    ID of the plan to which the customer should be subscribed.
    price string
    ID of the price to which the customer should be subscribed.
    priceData SubscriptionSchedulePhaseItemPriceData
    Data used to generate a new Price object inline.
    quantity number
    Quantity of the plan to which the customer should be subscribed.
    taxRates string[]
    The tax rates which apply to this phase_item. When set, the default_tax_rates on the phase do not apply to this phase_item.
    billing_thresholds SubscriptionSchedulePhaseItemBillingThresholds
    Define thresholds at which an invoice will be sent, and the related subscription advanced to a new billing period
    discounts Sequence[SubscriptionSchedulePhaseItemDiscount]
    The discounts applied to the subscription item. Subscription item discounts are applied before subscription discounts. Use expand[]=discounts to expand each discount.
    metadata Mapping[str, str]
    Set of key-value pairs that you can attach to an item. Metadata on this item will update the underlying subscription item's metadata when the phase is entered.
    plan str
    ID of the plan to which the customer should be subscribed.
    price str
    ID of the price to which the customer should be subscribed.
    price_data SubscriptionSchedulePhaseItemPriceData
    Data used to generate a new Price object inline.
    quantity float
    Quantity of the plan to which the customer should be subscribed.
    tax_rates Sequence[str]
    The tax rates which apply to this phase_item. When set, the default_tax_rates on the phase do not apply to this phase_item.
    billingThresholds Property Map
    Define thresholds at which an invoice will be sent, and the related subscription advanced to a new billing period
    discounts List<Property Map>
    The discounts applied to the subscription item. Subscription item discounts are applied before subscription discounts. Use expand[]=discounts to expand each discount.
    metadata Map<String>
    Set of key-value pairs that you can attach to an item. Metadata on this item will update the underlying subscription item's metadata when the phase is entered.
    plan String
    ID of the plan to which the customer should be subscribed.
    price String
    ID of the price to which the customer should be subscribed.
    priceData Property Map
    Data used to generate a new Price object inline.
    quantity Number
    Quantity of the plan to which the customer should be subscribed.
    taxRates List<String>
    The tax rates which apply to this phase_item. When set, the default_tax_rates on the phase do not apply to this phase_item.

    SubscriptionSchedulePhaseItemBillingThresholds, SubscriptionSchedulePhaseItemBillingThresholdsArgs

    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

    SubscriptionSchedulePhaseItemDiscount, SubscriptionSchedulePhaseItemDiscountArgs

    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.

    SubscriptionSchedulePhaseItemPriceData, SubscriptionSchedulePhaseItemPriceDataArgs

    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 SubscriptionSchedulePhaseItemPriceDataRecurring
    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 SubscriptionSchedulePhaseItemPriceDataRecurring
    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 SubscriptionSchedulePhaseItemPriceDataRecurring
    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 SubscriptionSchedulePhaseItemPriceDataRecurring
    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 SubscriptionSchedulePhaseItemPriceDataRecurring
    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.

    SubscriptionSchedulePhaseItemPriceDataRecurring, SubscriptionSchedulePhaseItemPriceDataRecurringArgs

    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).

    SubscriptionSchedulePhaseTransferData, SubscriptionSchedulePhaseTransferDataArgs

    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.

    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