diff --git a/OPENAPI_VERSION b/OPENAPI_VERSION index 0380667751..ce44fb5bb3 100644 --- a/OPENAPI_VERSION +++ b/OPENAPI_VERSION @@ -1 +1 @@ -v1370 \ No newline at end of file +v1381 \ No newline at end of file diff --git a/src/Stripe.net/Constants/EventTypes.cs b/src/Stripe.net/Constants/EventTypes.cs index 8303a93ce6..48cfd750aa 100644 --- a/src/Stripe.net/Constants/EventTypes.cs +++ b/src/Stripe.net/Constants/EventTypes.cs @@ -203,12 +203,14 @@ public static class EventTypes public const string ChargePending = "charge.pending"; /// - /// Occurs whenever a refund is updated, on selected payment methods. + /// Occurs whenever a refund is updated on selected payment methods. For updates on all + /// refunds, listen to refund.updated instead. /// public const string ChargeRefundUpdated = "charge.refund.updated"; /// - /// Occurs whenever a charge is refunded, including partial refunds. + /// Occurs whenever a charge is refunded, including partial refunds. Listen to + /// refund.created for information about the refund. /// public const string ChargeRefunded = "charge.refunded"; diff --git a/src/Stripe.net/Entities/Accounts/AccountCapabilities.cs b/src/Stripe.net/Entities/Accounts/AccountCapabilities.cs index 552c644b73..0078d7ae56 100644 --- a/src/Stripe.net/Entities/Accounts/AccountCapabilities.cs +++ b/src/Stripe.net/Entities/Accounts/AccountCapabilities.cs @@ -53,6 +53,13 @@ public class AccountCapabilities : StripeEntity [JsonProperty("au_becs_debit_payments")] public string AuBecsDebitPayments { get; set; } + /// + /// The status of the automatic_indirect_tax capability of the account. + /// One of: active, inactive, or pending. + /// + [JsonProperty("automatic_indirect_tax")] + public string AutomaticIndirectTax { get; set; } + /// /// The status of the Bacs Direct Debits payments capability of the account, or whether the /// account can directly process Bacs Direct Debits charges. diff --git a/src/Stripe.net/Entities/Billing/CreditGrants/CreditGrant.cs b/src/Stripe.net/Entities/Billing/CreditGrants/CreditGrant.cs index d7e7908360..ce69485656 100644 --- a/src/Stripe.net/Entities/Billing/CreditGrants/CreditGrant.cs +++ b/src/Stripe.net/Entities/Billing/CreditGrants/CreditGrant.cs @@ -81,7 +81,7 @@ public Customer Customer #endregion /// - /// The time when the billing credits become effective—when they're eligible for use. + /// The time when the billing credits become effective-when they're eligible for use. /// [JsonProperty("effective_at")] [JsonConverter(typeof(UnixDateTimeConverter))] diff --git a/src/Stripe.net/Entities/Billing/CreditGrants/CreditGrantApplicabilityConfigScope.cs b/src/Stripe.net/Entities/Billing/CreditGrants/CreditGrantApplicabilityConfigScope.cs index 5cc86cc9bc..ddc44baa6c 100644 --- a/src/Stripe.net/Entities/Billing/CreditGrants/CreditGrantApplicabilityConfigScope.cs +++ b/src/Stripe.net/Entities/Billing/CreditGrants/CreditGrantApplicabilityConfigScope.cs @@ -6,7 +6,7 @@ namespace Stripe.Billing public class CreditGrantApplicabilityConfigScope : StripeEntity { /// - /// The price type for which credit grants can apply. We currently only support the + /// The price type that credit grants can apply to. We currently only support the /// metered price type. This refers to prices that have a Billing Meter attached to them. /// diff --git a/src/Stripe.net/Entities/Billing/MeterEvents/MeterEvent.cs b/src/Stripe.net/Entities/Billing/MeterEvents/MeterEvent.cs index d1e021a12e..1674224f23 100644 --- a/src/Stripe.net/Entities/Billing/MeterEvents/MeterEvent.cs +++ b/src/Stripe.net/Entities/Billing/MeterEvents/MeterEvent.cs @@ -7,10 +7,10 @@ namespace Stripe.Billing using Stripe.Infrastructure; /// - /// A billing meter event represents a customer's usage of a product. Meter events are used - /// to bill a customer based on their usage. Meter events are associated with billing - /// meters, which define the shape of the event's payload and how those events are - /// aggregated for billing. + /// Meter events represent actions that customers take in your system. You can use meter + /// events to bill a customer based on their usage. Meter events are associated with billing + /// meters, which define both the contents of the event’s payload and how to aggregate those + /// events. /// public class MeterEvent : StripeEntity, IHasObject { diff --git a/src/Stripe.net/Entities/Billing/Meters/Meter.cs b/src/Stripe.net/Entities/Billing/Meters/Meter.cs index 48e4a1bf1a..b7423b7a39 100644 --- a/src/Stripe.net/Entities/Billing/Meters/Meter.cs +++ b/src/Stripe.net/Entities/Billing/Meters/Meter.cs @@ -6,10 +6,9 @@ namespace Stripe.Billing using Stripe.Infrastructure; /// - /// A billing meter is a resource that allows you to track usage of a particular event. For - /// example, you might create a billing meter to track the number of API calls made by a - /// particular user. You can then attach the billing meter to a price and attach the price - /// to a subscription to charge the user for the number of API calls they make. + /// Meters specify how to aggregate meter events over a billing period. Meter events + /// represent the actions that customers take in your system. Meters attach to prices and + /// form the basis of the bill. /// /// Related guide: Usage /// based billing. diff --git a/src/Stripe.net/Entities/Invoices/InvoiceAutomaticTax.cs b/src/Stripe.net/Entities/Invoices/InvoiceAutomaticTax.cs index bac2c6d988..39d8b96ffc 100644 --- a/src/Stripe.net/Entities/Invoices/InvoiceAutomaticTax.cs +++ b/src/Stripe.net/Entities/Invoices/InvoiceAutomaticTax.cs @@ -5,6 +5,14 @@ namespace Stripe public class InvoiceAutomaticTax : StripeEntity { + /// + /// If Stripe disabled automatic tax, this enum describes why. + /// One of: finalization_requires_location_inputs, or + /// finalization_system_error. + /// + [JsonProperty("disabled_reason")] + public string DisabledReason { get; set; } + /// /// Whether Stripe automatically computes tax on this invoice. Note that incompatible /// invoice items (invoice items with manually specified { + /// + /// If Stripe disabled automatic tax, this enum describes why. + /// One of: finalization_requires_location_inputs, or + /// finalization_system_error. + /// + [JsonProperty("disabled_reason")] + public string DisabledReason { get; set; } + /// /// Whether Stripe automatically computes tax on this invoice. Note that incompatible /// invoice items (invoice items with manually specified { + /// + /// If Stripe disabled automatic tax, this enum describes why. + /// + [JsonProperty("disabled_reason")] + public string DisabledReason { get; set; } + /// /// Whether Stripe automatically computes tax on invoices created during this phase. /// diff --git a/src/Stripe.net/Entities/QuotePreviewSubscriptionSchedules/QuotePreviewSubscriptionSchedulePhaseAutomaticTax.cs b/src/Stripe.net/Entities/QuotePreviewSubscriptionSchedules/QuotePreviewSubscriptionSchedulePhaseAutomaticTax.cs index ca465c41e9..13b58ef859 100644 --- a/src/Stripe.net/Entities/QuotePreviewSubscriptionSchedules/QuotePreviewSubscriptionSchedulePhaseAutomaticTax.cs +++ b/src/Stripe.net/Entities/QuotePreviewSubscriptionSchedules/QuotePreviewSubscriptionSchedulePhaseAutomaticTax.cs @@ -5,6 +5,12 @@ namespace Stripe public class QuotePreviewSubscriptionSchedulePhaseAutomaticTax : StripeEntity { + /// + /// If Stripe disabled automatic tax, this enum describes why. + /// + [JsonProperty("disabled_reason")] + public string DisabledReason { get; set; } + /// /// Whether Stripe automatically computes tax on invoices created during this phase. /// diff --git a/src/Stripe.net/Entities/SubscriptionSchedules/SubscriptionScheduleDefaultSettingsAutomaticTax.cs b/src/Stripe.net/Entities/SubscriptionSchedules/SubscriptionScheduleDefaultSettingsAutomaticTax.cs index 60e4aebe7f..f7858ea804 100644 --- a/src/Stripe.net/Entities/SubscriptionSchedules/SubscriptionScheduleDefaultSettingsAutomaticTax.cs +++ b/src/Stripe.net/Entities/SubscriptionSchedules/SubscriptionScheduleDefaultSettingsAutomaticTax.cs @@ -5,6 +5,12 @@ namespace Stripe public class SubscriptionScheduleDefaultSettingsAutomaticTax : StripeEntity { + /// + /// If Stripe disabled automatic tax, this enum describes why. + /// + [JsonProperty("disabled_reason")] + public string DisabledReason { get; set; } + /// /// Whether Stripe automatically computes tax on invoices created during this phase. /// diff --git a/src/Stripe.net/Entities/SubscriptionSchedules/SubscriptionSchedulePhaseAutomaticTax.cs b/src/Stripe.net/Entities/SubscriptionSchedules/SubscriptionSchedulePhaseAutomaticTax.cs index f59a708da2..70e688e37d 100644 --- a/src/Stripe.net/Entities/SubscriptionSchedules/SubscriptionSchedulePhaseAutomaticTax.cs +++ b/src/Stripe.net/Entities/SubscriptionSchedules/SubscriptionSchedulePhaseAutomaticTax.cs @@ -5,6 +5,12 @@ namespace Stripe public class SubscriptionSchedulePhaseAutomaticTax : StripeEntity { + /// + /// If Stripe disabled automatic tax, this enum describes why. + /// + [JsonProperty("disabled_reason")] + public string DisabledReason { get; set; } + /// /// Whether Stripe automatically computes tax on invoices created during this phase. /// diff --git a/src/Stripe.net/Entities/Subscriptions/SubscriptionAutomaticTax.cs b/src/Stripe.net/Entities/Subscriptions/SubscriptionAutomaticTax.cs index d23638bf11..2d0b1369e4 100644 --- a/src/Stripe.net/Entities/Subscriptions/SubscriptionAutomaticTax.cs +++ b/src/Stripe.net/Entities/Subscriptions/SubscriptionAutomaticTax.cs @@ -5,6 +5,12 @@ namespace Stripe public class SubscriptionAutomaticTax : StripeEntity { + /// + /// If Stripe disabled automatic tax, this enum describes why. + /// + [JsonProperty("disabled_reason")] + public string DisabledReason { get; set; } + /// /// Whether Stripe automatically computes tax on this subscription. /// diff --git a/src/Stripe.net/Services/Accounts/AccountCapabilitiesAutomaticIndirectTaxOptions.cs b/src/Stripe.net/Services/Accounts/AccountCapabilitiesAutomaticIndirectTaxOptions.cs new file mode 100644 index 0000000000..1da60836b4 --- /dev/null +++ b/src/Stripe.net/Services/Accounts/AccountCapabilitiesAutomaticIndirectTaxOptions.cs @@ -0,0 +1,16 @@ +// File generated from our OpenAPI spec +namespace Stripe +{ + using Newtonsoft.Json; + + public class AccountCapabilitiesAutomaticIndirectTaxOptions : INestedOptions + { + /// + /// Passing true requests the capability for the account, if it is not already requested. A + /// requested capability may not immediately become active. Any requirements to activate the + /// capability are returned in the requirements arrays. + /// + [JsonProperty("requested")] + public bool? Requested { get; set; } + } +} diff --git a/src/Stripe.net/Services/Accounts/AccountCapabilitiesOptions.cs b/src/Stripe.net/Services/Accounts/AccountCapabilitiesOptions.cs index 0c21aaa815..dc08bb491d 100644 --- a/src/Stripe.net/Services/Accounts/AccountCapabilitiesOptions.cs +++ b/src/Stripe.net/Services/Accounts/AccountCapabilitiesOptions.cs @@ -41,6 +41,12 @@ public class AccountCapabilitiesOptions : INestedOptions [JsonProperty("au_becs_debit_payments")] public AccountCapabilitiesAuBecsDebitPaymentsOptions AuBecsDebitPayments { get; set; } + /// + /// The automatic_indirect_tax capability. + /// + [JsonProperty("automatic_indirect_tax")] + public AccountCapabilitiesAutomaticIndirectTaxOptions AutomaticIndirectTax { get; set; } + /// /// The bacs_debit_payments capability. /// diff --git a/src/Stripe.net/Services/Billing/CreditBalanceSummaries/CreditBalanceSummaryFilterApplicabilityScopeOptions.cs b/src/Stripe.net/Services/Billing/CreditBalanceSummaries/CreditBalanceSummaryFilterApplicabilityScopeOptions.cs index 16808a8646..f51102dedc 100644 --- a/src/Stripe.net/Services/Billing/CreditBalanceSummaries/CreditBalanceSummaryFilterApplicabilityScopeOptions.cs +++ b/src/Stripe.net/Services/Billing/CreditBalanceSummaries/CreditBalanceSummaryFilterApplicabilityScopeOptions.cs @@ -6,7 +6,7 @@ namespace Stripe.Billing public class CreditBalanceSummaryFilterApplicabilityScopeOptions : INestedOptions { /// - /// The price type for which credit grants can apply. We currently only support the + /// The price type that credit grants can apply to. We currently only support the /// metered price type. /// [JsonProperty("price_type")] diff --git a/src/Stripe.net/Services/Billing/CreditBalanceSummaries/CreditBalanceSummaryService.cs b/src/Stripe.net/Services/Billing/CreditBalanceSummaries/CreditBalanceSummaryService.cs index 734cf988a3..5691441acf 100644 --- a/src/Stripe.net/Services/Billing/CreditBalanceSummaries/CreditBalanceSummaryService.cs +++ b/src/Stripe.net/Services/Billing/CreditBalanceSummaries/CreditBalanceSummaryService.cs @@ -24,7 +24,7 @@ public CreditBalanceSummaryService(IStripeClient client) } /// - ///

Retrieves the credit balance summary for a customer

. + ///

Retrieves the credit balance summary for a customer.

. /// public virtual CreditBalanceSummary Get(RequestOptions requestOptions = null) { @@ -32,7 +32,7 @@ public virtual CreditBalanceSummary Get(RequestOptions requestOptions = null) } /// - ///

Retrieves the credit balance summary for a customer

. + ///

Retrieves the credit balance summary for a customer.

. /// public virtual Task GetAsync(RequestOptions requestOptions = null, CancellationToken cancellationToken = default) { @@ -40,7 +40,7 @@ public virtual Task GetAsync(RequestOptions requestOptions } /// - ///

Retrieves the credit balance summary for a customer

. + ///

Retrieves the credit balance summary for a customer.

. /// public virtual CreditBalanceSummary Get(CreditBalanceSummaryGetOptions options, RequestOptions requestOptions = null) { @@ -48,7 +48,7 @@ public virtual CreditBalanceSummary Get(CreditBalanceSummaryGetOptions options, } /// - ///

Retrieves the credit balance summary for a customer

. + ///

Retrieves the credit balance summary for a customer.

. /// public virtual Task GetAsync(CreditBalanceSummaryGetOptions options, RequestOptions requestOptions = null, CancellationToken cancellationToken = default) { diff --git a/src/Stripe.net/Services/Billing/CreditBalanceTransactions/CreditBalanceTransactionService.cs b/src/Stripe.net/Services/Billing/CreditBalanceTransactions/CreditBalanceTransactionService.cs index c9fb0d0f92..2262dd332b 100644 --- a/src/Stripe.net/Services/Billing/CreditBalanceTransactions/CreditBalanceTransactionService.cs +++ b/src/Stripe.net/Services/Billing/CreditBalanceTransactions/CreditBalanceTransactionService.cs @@ -27,7 +27,7 @@ public CreditBalanceTransactionService(IStripeClient client) } /// - ///

Retrieves a credit balance transaction

. + ///

Retrieves a credit balance transaction.

. /// public virtual CreditBalanceTransaction Get(string id, CreditBalanceTransactionGetOptions options = null, RequestOptions requestOptions = null) { @@ -35,7 +35,7 @@ public virtual CreditBalanceTransaction Get(string id, CreditBalanceTransactionG } /// - ///

Retrieves a credit balance transaction

. + ///

Retrieves a credit balance transaction.

. /// public virtual Task GetAsync(string id, CreditBalanceTransactionGetOptions options = null, RequestOptions requestOptions = null, CancellationToken cancellationToken = default) { @@ -43,7 +43,7 @@ public virtual Task GetAsync(string id, CreditBalanceT } /// - ///

Retrieve a list of credit balance transactions

. + ///

Retrieve a list of credit balance transactions.

. /// public virtual StripeList List(CreditBalanceTransactionListOptions options = null, RequestOptions requestOptions = null) { @@ -51,7 +51,7 @@ public virtual StripeList List(CreditBalanceTransactio } /// - ///

Retrieve a list of credit balance transactions

. + ///

Retrieve a list of credit balance transactions.

. /// public virtual Task> ListAsync(CreditBalanceTransactionListOptions options = null, RequestOptions requestOptions = null, CancellationToken cancellationToken = default) { @@ -59,7 +59,7 @@ public virtual Task> ListAsync(CreditBalanc } /// - ///

Retrieve a list of credit balance transactions

. + ///

Retrieve a list of credit balance transactions.

. /// public virtual IEnumerable ListAutoPaging(CreditBalanceTransactionListOptions options = null, RequestOptions requestOptions = null) { @@ -67,7 +67,7 @@ public virtual IEnumerable ListAutoPaging(CreditBalanc } /// - ///

Retrieve a list of credit balance transactions

. + ///

Retrieve a list of credit balance transactions.

. /// public virtual IAsyncEnumerable ListAutoPagingAsync(CreditBalanceTransactionListOptions options = null, RequestOptions requestOptions = null, CancellationToken cancellationToken = default) { diff --git a/src/Stripe.net/Services/Billing/CreditGrants/CreditGrantApplicabilityConfigScopeOptions.cs b/src/Stripe.net/Services/Billing/CreditGrants/CreditGrantApplicabilityConfigScopeOptions.cs index 68d0cfe080..b8db21f960 100644 --- a/src/Stripe.net/Services/Billing/CreditGrants/CreditGrantApplicabilityConfigScopeOptions.cs +++ b/src/Stripe.net/Services/Billing/CreditGrants/CreditGrantApplicabilityConfigScopeOptions.cs @@ -6,7 +6,7 @@ namespace Stripe.Billing public class CreditGrantApplicabilityConfigScopeOptions : INestedOptions { /// - /// The price type for which credit grants can apply. We currently only support the + /// The price type that credit grants can apply to. We currently only support the /// metered price type. /// [JsonProperty("price_type")] diff --git a/src/Stripe.net/Services/Billing/CreditGrants/CreditGrantCreateOptions.cs b/src/Stripe.net/Services/Billing/CreditGrants/CreditGrantCreateOptions.cs index de7b1ef117..5c7a459d41 100644 --- a/src/Stripe.net/Services/Billing/CreditGrants/CreditGrantCreateOptions.cs +++ b/src/Stripe.net/Services/Billing/CreditGrants/CreditGrantCreateOptions.cs @@ -34,23 +34,23 @@ public class CreditGrantCreateOptions : BaseOptions, IHasMetadata public string Customer { get; set; } /// - /// The time when the billing credits become effective—when they're eligible for use. - /// Defaults to the current timestamp if not specified. + /// The time when the billing credits become effective-when they're eligible for use. It + /// defaults to the current timestamp if not specified. /// [JsonProperty("effective_at")] [JsonConverter(typeof(UnixDateTimeConverter))] public DateTime? EffectiveAt { get; set; } /// - /// The time when the billing credits will expire. If not specified, the billing credits - /// don't expire. + /// The time when the billing credits expire. If not specified, the billing credits don't + /// expire. /// [JsonProperty("expires_at")] [JsonConverter(typeof(UnixDateTimeConverter))] public DateTime? ExpiresAt { get; set; } /// - /// Set of key-value pairs that you can attach to an object. This can be useful for storing + /// Set of key-value pairs that you can attach to an object. You can use this to store /// additional information about the object (for example, cost basis) in a structured /// format. /// diff --git a/src/Stripe.net/Services/Billing/CreditGrants/CreditGrantService.cs b/src/Stripe.net/Services/Billing/CreditGrants/CreditGrantService.cs index 7bbacbd541..4e39cccadc 100644 --- a/src/Stripe.net/Services/Billing/CreditGrants/CreditGrantService.cs +++ b/src/Stripe.net/Services/Billing/CreditGrants/CreditGrantService.cs @@ -29,7 +29,7 @@ public CreditGrantService(IStripeClient client) } /// - ///

Creates a credit grant

. + ///

Creates a credit grant.

. /// public virtual CreditGrant Create(CreditGrantCreateOptions options, RequestOptions requestOptions = null) { @@ -37,7 +37,7 @@ public virtual CreditGrant Create(CreditGrantCreateOptions options, RequestOptio } /// - ///

Creates a credit grant

. + ///

Creates a credit grant.

. /// public virtual Task CreateAsync(CreditGrantCreateOptions options, RequestOptions requestOptions = null, CancellationToken cancellationToken = default) { @@ -61,7 +61,7 @@ public virtual Task ExpireAsync(string id, CreditGrantExpireOptions } /// - ///

Retrieves a credit grant

. + ///

Retrieves a credit grant.

. /// public virtual CreditGrant Get(string id, CreditGrantGetOptions options = null, RequestOptions requestOptions = null) { @@ -69,7 +69,7 @@ public virtual CreditGrant Get(string id, CreditGrantGetOptions options = null, } /// - ///

Retrieves a credit grant

. + ///

Retrieves a credit grant.

. /// public virtual Task GetAsync(string id, CreditGrantGetOptions options = null, RequestOptions requestOptions = null, CancellationToken cancellationToken = default) { @@ -109,7 +109,7 @@ public virtual IAsyncEnumerable ListAutoPagingAsync(CreditGrantList } /// - ///

Updates a credit grant

. + ///

Updates a credit grant.

. /// public virtual CreditGrant Update(string id, CreditGrantUpdateOptions options, RequestOptions requestOptions = null) { @@ -117,7 +117,7 @@ public virtual CreditGrant Update(string id, CreditGrantUpdateOptions options, R } /// - ///

Updates a credit grant

. + ///

Updates a credit grant.

. /// public virtual Task UpdateAsync(string id, CreditGrantUpdateOptions options, RequestOptions requestOptions = null, CancellationToken cancellationToken = default) { diff --git a/src/Stripe.net/Services/Billing/CreditGrants/CreditGrantUpdateOptions.cs b/src/Stripe.net/Services/Billing/CreditGrants/CreditGrantUpdateOptions.cs index 988ed67333..7a5ca34a62 100644 --- a/src/Stripe.net/Services/Billing/CreditGrants/CreditGrantUpdateOptions.cs +++ b/src/Stripe.net/Services/Billing/CreditGrants/CreditGrantUpdateOptions.cs @@ -17,9 +17,8 @@ public class CreditGrantUpdateOptions : BaseOptions, IHasMetadata public DateTime? ExpiresAt { get; set; } /// - /// Set of key-value pairs you can attach to an object. This can be useful for storing - /// additional information about the object (for example, cost basis) in a structured - /// format. + /// Set of key-value pairs you can attach to an object. You can use this to store additional + /// information about the object (for example, cost basis) in a structured format. /// [JsonProperty("metadata")] public Dictionary Metadata { get; set; } diff --git a/src/Stripe.net/Services/Billing/MeterEventAdjustments/MeterEventAdjustmentService.cs b/src/Stripe.net/Services/Billing/MeterEventAdjustments/MeterEventAdjustmentService.cs index 0e5ff233a0..3c6a3b1dda 100644 --- a/src/Stripe.net/Services/Billing/MeterEventAdjustments/MeterEventAdjustmentService.cs +++ b/src/Stripe.net/Services/Billing/MeterEventAdjustments/MeterEventAdjustmentService.cs @@ -24,7 +24,7 @@ public MeterEventAdjustmentService(IStripeClient client) } /// - ///

Creates a billing meter event adjustment

. + ///

Creates a billing meter event adjustment.

. /// public virtual MeterEventAdjustment Create(MeterEventAdjustmentCreateOptions options, RequestOptions requestOptions = null) { @@ -32,7 +32,7 @@ public virtual MeterEventAdjustment Create(MeterEventAdjustmentCreateOptions opt } /// - ///

Creates a billing meter event adjustment

. + ///

Creates a billing meter event adjustment.

. /// public virtual Task CreateAsync(MeterEventAdjustmentCreateOptions options, RequestOptions requestOptions = null, CancellationToken cancellationToken = default) { diff --git a/src/Stripe.net/Services/Billing/MeterEvents/MeterEventCreateOptions.cs b/src/Stripe.net/Services/Billing/MeterEvents/MeterEventCreateOptions.cs index 62ea158d0f..a1503364b9 100644 --- a/src/Stripe.net/Services/Billing/MeterEvents/MeterEventCreateOptions.cs +++ b/src/Stripe.net/Services/Billing/MeterEvents/MeterEventCreateOptions.cs @@ -15,12 +15,11 @@ public class MeterEventCreateOptions : BaseOptions public string EventName { get; set; } /// - /// A unique identifier for the event. If not provided, one will be generated. We strongly - /// advise using UUID-like identifiers. We will enforce uniqueness within a rolling period - /// of at least 24 hours. The enforcement of uniqueness primarily addresses issues arising - /// from accidental retries or other problems occurring within extremely brief time - /// intervals. This approach helps prevent duplicate entries and ensures data integrity in - /// high-frequency operations. + /// A unique identifier for the event. If not provided, one is generated. We recommend using + /// UUID-like identifiers. We will enforce uniqueness within a rolling period of at least 24 + /// hours. The enforcement of uniqueness primarily addresses issues arising from accidental + /// retries or other problems occurring within extremely brief time intervals. This approach + /// helps prevent duplicate entries and ensures data integrity in high-frequency operations. /// [JsonProperty("identifier")] public string Identifier { get; set; } diff --git a/src/Stripe.net/Services/Billing/MeterEvents/MeterEventService.cs b/src/Stripe.net/Services/Billing/MeterEvents/MeterEventService.cs index 7a679d638e..0e72b36e9c 100644 --- a/src/Stripe.net/Services/Billing/MeterEvents/MeterEventService.cs +++ b/src/Stripe.net/Services/Billing/MeterEvents/MeterEventService.cs @@ -24,7 +24,7 @@ public MeterEventService(IStripeClient client) } /// - ///

Creates a billing meter event

. + ///

Creates a billing meter event.

. /// public virtual MeterEvent Create(MeterEventCreateOptions options, RequestOptions requestOptions = null) { @@ -32,7 +32,7 @@ public virtual MeterEvent Create(MeterEventCreateOptions options, RequestOptions } /// - ///

Creates a billing meter event

. + ///

Creates a billing meter event.

. /// public virtual Task CreateAsync(MeterEventCreateOptions options, RequestOptions requestOptions = null, CancellationToken cancellationToken = default) { diff --git a/src/Stripe.net/Services/Billing/Meters/MeterCreateOptions.cs b/src/Stripe.net/Services/Billing/Meters/MeterCreateOptions.cs index 1f0503a396..5e721013e6 100644 --- a/src/Stripe.net/Services/Billing/Meters/MeterCreateOptions.cs +++ b/src/Stripe.net/Services/Billing/Meters/MeterCreateOptions.cs @@ -18,7 +18,7 @@ public class MeterCreateOptions : BaseOptions public MeterDefaultAggregationOptions DefaultAggregation { get; set; } /// - /// The meter's name. + /// The meter’s name. Not visible to the customer. /// [JsonProperty("display_name")] public string DisplayName { get; set; } diff --git a/src/Stripe.net/Services/Billing/Meters/MeterCustomerMappingOptions.cs b/src/Stripe.net/Services/Billing/Meters/MeterCustomerMappingOptions.cs index 7af7720cef..bd66dae743 100644 --- a/src/Stripe.net/Services/Billing/Meters/MeterCustomerMappingOptions.cs +++ b/src/Stripe.net/Services/Billing/Meters/MeterCustomerMappingOptions.cs @@ -6,7 +6,7 @@ namespace Stripe.Billing public class MeterCustomerMappingOptions : INestedOptions { /// - /// The key in the usage event payload to use for mapping the event to a customer. + /// The key in the meter event payload to use for mapping the event to a customer. /// [JsonProperty("event_payload_key")] public string EventPayloadKey { get; set; } diff --git a/src/Stripe.net/Services/Billing/Meters/MeterService.cs b/src/Stripe.net/Services/Billing/Meters/MeterService.cs index 848d3db3e4..2dde43d57d 100644 --- a/src/Stripe.net/Services/Billing/Meters/MeterService.cs +++ b/src/Stripe.net/Services/Billing/Meters/MeterService.cs @@ -34,7 +34,7 @@ public MeterService(IStripeClient client) this.Requestor); /// - ///

Creates a billing meter

. + ///

Creates a billing meter.

. /// public virtual Meter Create(MeterCreateOptions options, RequestOptions requestOptions = null) { @@ -42,7 +42,7 @@ public virtual Meter Create(MeterCreateOptions options, RequestOptions requestOp } /// - ///

Creates a billing meter

. + ///

Creates a billing meter.

. /// public virtual Task CreateAsync(MeterCreateOptions options, RequestOptions requestOptions = null, CancellationToken cancellationToken = default) { @@ -50,7 +50,8 @@ public virtual Task CreateAsync(MeterCreateOptions options, RequestOption } /// - ///

Deactivates a billing meter

. + ///

When a meter is deactivated, no more meter events will be accepted for this meter. + /// You can’t attach a deactivated meter to a price.

. /// public virtual Meter Deactivate(string id, MeterDeactivateOptions options = null, RequestOptions requestOptions = null) { @@ -58,7 +59,8 @@ public virtual Meter Deactivate(string id, MeterDeactivateOptions options = null } /// - ///

Deactivates a billing meter

. + ///

When a meter is deactivated, no more meter events will be accepted for this meter. + /// You can’t attach a deactivated meter to a price.

. /// public virtual Task DeactivateAsync(string id, MeterDeactivateOptions options = null, RequestOptions requestOptions = null, CancellationToken cancellationToken = default) { @@ -66,7 +68,7 @@ public virtual Task DeactivateAsync(string id, MeterDeactivateOptions opt } /// - ///

Retrieves a billing meter given an ID

. + ///

Retrieves a billing meter given an ID.

. /// public virtual Meter Get(string id, MeterGetOptions options = null, RequestOptions requestOptions = null) { @@ -74,7 +76,7 @@ public virtual Meter Get(string id, MeterGetOptions options = null, RequestOptio } /// - ///

Retrieves a billing meter given an ID

. + ///

Retrieves a billing meter given an ID.

. /// public virtual Task GetAsync(string id, MeterGetOptions options = null, RequestOptions requestOptions = null, CancellationToken cancellationToken = default) { @@ -114,7 +116,8 @@ public virtual IAsyncEnumerable ListAutoPagingAsync(MeterListOptions opti } /// - ///

Reactivates a billing meter

. + ///

When a meter is reactivated, events for this meter can be accepted and you can attach + /// the meter to a price.

. /// public virtual Meter Reactivate(string id, MeterReactivateOptions options = null, RequestOptions requestOptions = null) { @@ -122,7 +125,8 @@ public virtual Meter Reactivate(string id, MeterReactivateOptions options = null } /// - ///

Reactivates a billing meter

. + ///

When a meter is reactivated, events for this meter can be accepted and you can attach + /// the meter to a price.

. /// public virtual Task ReactivateAsync(string id, MeterReactivateOptions options = null, RequestOptions requestOptions = null, CancellationToken cancellationToken = default) { @@ -130,7 +134,7 @@ public virtual Task ReactivateAsync(string id, MeterReactivateOptions opt } /// - ///

Updates a billing meter

. + ///

Updates a billing meter.

. /// public virtual Meter Update(string id, MeterUpdateOptions options, RequestOptions requestOptions = null) { @@ -138,7 +142,7 @@ public virtual Meter Update(string id, MeterUpdateOptions options, RequestOption } /// - ///

Updates a billing meter

. + ///

Updates a billing meter.

. /// public virtual Task UpdateAsync(string id, MeterUpdateOptions options, RequestOptions requestOptions = null, CancellationToken cancellationToken = default) { diff --git a/src/Stripe.net/Services/Billing/Meters/MeterUpdateOptions.cs b/src/Stripe.net/Services/Billing/Meters/MeterUpdateOptions.cs index 320ffcddf5..a8788a5f6d 100644 --- a/src/Stripe.net/Services/Billing/Meters/MeterUpdateOptions.cs +++ b/src/Stripe.net/Services/Billing/Meters/MeterUpdateOptions.cs @@ -6,7 +6,7 @@ namespace Stripe.Billing public class MeterUpdateOptions : BaseOptions { /// - /// The meter's name. + /// The meter’s name. Not visible to the customer. /// [JsonProperty("display_name")] public string DisplayName { get; set; } diff --git a/src/Stripe.net/Services/Checkout/Sessions/SessionUpdateOptions.cs b/src/Stripe.net/Services/Checkout/Sessions/SessionUpdateOptions.cs index e51302c174..0b043140fb 100644 --- a/src/Stripe.net/Services/Checkout/Sessions/SessionUpdateOptions.cs +++ b/src/Stripe.net/Services/Checkout/Sessions/SessionUpdateOptions.cs @@ -15,15 +15,15 @@ public class SessionUpdateOptions : BaseOptions, IHasMetadata /// /// A list of items the customer is purchasing. /// - /// When updating line items, the entire array of line items must be retransmitted. + /// When updating line items, you must retransmit the entire array of line items. /// /// To retain an existing line item, specify its id. /// /// To update an existing line item, specify its id along with the new values of the - /// fields to be updated. + /// fields to update. /// - /// To add a new line item, specify a price and quantity. Recurring prices are - /// not supported yet. + /// To add a new line item, specify a price and quantity. We don't currently + /// support recurring prices. /// /// To remove an existing line item, omit the line item's ID from the retransmitted array. /// diff --git a/src/Stripe.net/Services/Customers/CustomerTaxOptions.cs b/src/Stripe.net/Services/Customers/CustomerTaxOptions.cs index c965cd7dcd..9b166e88fe 100644 --- a/src/Stripe.net/Services/Customers/CustomerTaxOptions.cs +++ b/src/Stripe.net/Services/Customers/CustomerTaxOptions.cs @@ -16,7 +16,7 @@ public class CustomerTaxOptions : INestedOptions /// /// A flag that indicates when Stripe should validate the customer tax location. Defaults to - /// deferred. + /// auto. /// One of: auto, deferred, or immediately. /// [JsonProperty("validate_location")] diff --git a/src/Stripe.net/Services/InvoiceUpcomingLines/InvoiceUpcomingLinesSubscriptionDetailsItemOptions.cs b/src/Stripe.net/Services/InvoiceUpcomingLines/InvoiceUpcomingLinesSubscriptionDetailsItemOptions.cs index ea07a4cede..6a8edcfe40 100644 --- a/src/Stripe.net/Services/InvoiceUpcomingLines/InvoiceUpcomingLinesSubscriptionDetailsItemOptions.cs +++ b/src/Stripe.net/Services/InvoiceUpcomingLines/InvoiceUpcomingLinesSubscriptionDetailsItemOptions.cs @@ -15,8 +15,9 @@ public class InvoiceUpcomingLinesSubscriptionDetailsItemOptions : INestedOptions public InvoiceUpcomingLinesSubscriptionDetailsItemBillingThresholdsOptions BillingThresholds { get; set; } /// - /// Delete all usage for a given subscription item. Allowed only when deleted is set - /// to true and the current plan's usage_type is metered. + /// Delete all usage for a given subscription item. You must pass this when deleting a usage + /// records subscription item. clear_usage has no effect if the plan has a billing + /// meter attached. /// [JsonProperty("clear_usage")] public bool? ClearUsage { get; set; } diff --git a/src/Stripe.net/Services/InvoiceUpcomingLines/InvoiceUpcomingLinesSubscriptionItemOptions.cs b/src/Stripe.net/Services/InvoiceUpcomingLines/InvoiceUpcomingLinesSubscriptionItemOptions.cs index e3f26aa86f..9ec6b7760e 100644 --- a/src/Stripe.net/Services/InvoiceUpcomingLines/InvoiceUpcomingLinesSubscriptionItemOptions.cs +++ b/src/Stripe.net/Services/InvoiceUpcomingLines/InvoiceUpcomingLinesSubscriptionItemOptions.cs @@ -15,8 +15,9 @@ public class InvoiceUpcomingLinesSubscriptionItemOptions : INestedOptions, IHasI public InvoiceUpcomingLinesSubscriptionItemBillingThresholdsOptions BillingThresholds { get; set; } /// - /// Delete all usage for a given subscription item. Allowed only when deleted is set - /// to true and the current plan's usage_type is metered. + /// Delete all usage for a given subscription item. You must pass this when deleting a usage + /// records subscription item. clear_usage has no effect if the plan has a billing + /// meter attached. /// [JsonProperty("clear_usage")] public bool? ClearUsage { get; set; } diff --git a/src/Stripe.net/Services/Invoices/InvoiceSubscriptionDetailsItemOptions.cs b/src/Stripe.net/Services/Invoices/InvoiceSubscriptionDetailsItemOptions.cs index 95b89132eb..0478a4b070 100644 --- a/src/Stripe.net/Services/Invoices/InvoiceSubscriptionDetailsItemOptions.cs +++ b/src/Stripe.net/Services/Invoices/InvoiceSubscriptionDetailsItemOptions.cs @@ -15,8 +15,9 @@ public class InvoiceSubscriptionDetailsItemOptions : INestedOptions, IHasId, IHa public InvoiceSubscriptionDetailsItemBillingThresholdsOptions BillingThresholds { get; set; } /// - /// Delete all usage for a given subscription item. Allowed only when deleted is set - /// to true and the current plan's usage_type is metered. + /// Delete all usage for a given subscription item. You must pass this when deleting a usage + /// records subscription item. clear_usage has no effect if the plan has a billing + /// meter attached. /// [JsonProperty("clear_usage")] public bool? ClearUsage { get; set; } diff --git a/src/Stripe.net/Services/Invoices/InvoiceSubscriptionItemOptions.cs b/src/Stripe.net/Services/Invoices/InvoiceSubscriptionItemOptions.cs index bdd64206c5..e7db32aaae 100644 --- a/src/Stripe.net/Services/Invoices/InvoiceSubscriptionItemOptions.cs +++ b/src/Stripe.net/Services/Invoices/InvoiceSubscriptionItemOptions.cs @@ -15,8 +15,9 @@ public class InvoiceSubscriptionItemOptions : INestedOptions, IHasId, IHasMetada public InvoiceSubscriptionItemBillingThresholdsOptions BillingThresholds { get; set; } /// - /// Delete all usage for a given subscription item. Allowed only when deleted is set - /// to true and the current plan's usage_type is metered. + /// Delete all usage for a given subscription item. You must pass this when deleting a usage + /// records subscription item. clear_usage has no effect if the plan has a billing + /// meter attached. /// [JsonProperty("clear_usage")] public bool? ClearUsage { get; set; } diff --git a/src/Stripe.net/Services/Subscriptions/SubscriptionItemOptions.cs b/src/Stripe.net/Services/Subscriptions/SubscriptionItemOptions.cs index 0bcf026bef..94fae3f1f9 100644 --- a/src/Stripe.net/Services/Subscriptions/SubscriptionItemOptions.cs +++ b/src/Stripe.net/Services/Subscriptions/SubscriptionItemOptions.cs @@ -15,8 +15,9 @@ public class SubscriptionItemOptions : INestedOptions, IHasId, IHasMetadata public SubscriptionItemBillingThresholdsOptions BillingThresholds { get; set; } /// - /// Delete all usage for a given subscription item. Allowed only when deleted is set - /// to true and the current plan's usage_type is metered. + /// Delete all usage for a given subscription item. You must pass this when deleting a usage + /// records subscription item. clear_usage has no effect if the plan has a billing + /// meter attached. /// [JsonProperty("clear_usage")] public bool? ClearUsage { get; set; }