Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

API Updates #1586

Merged
merged 1 commit into from
Dec 22, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion OPENAPI_VERSION
Original file line number Diff line number Diff line change
@@ -1 +1 @@
v214
v216
3 changes: 2 additions & 1 deletion balance.go
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,8 @@ const (
)

// Retrieves the current account balance, based on the authentication that was used to make the request.
// For a sample request, see [Accounting for negative balances](https://stripe.com/docs/connect/account-balances#accounting-for-negative-balances).
//
// For a sample request, see [Accounting for negative balances](https://stripe.com/docs/connect/account-balances#accounting-for-negative-balances).
type BalanceParams struct {
Params `form:"*"`
}
Expand Down
4 changes: 3 additions & 1 deletion cashbalance.go
Original file line number Diff line number Diff line change
Expand Up @@ -25,12 +25,14 @@ type CashBalanceParams struct {

// A hash of settings for this cash balance.
type CashBalanceSettingsParams struct {
// Controls how funds transferred by the customer are applied to payment intents and invoices. Valid options are `automatic` or `manual`. For more information about these reconciliation modes, see [Reconciliation](https://stripe.com/docs/payments/customer-balance/reconciliation).
// Controls how funds transferred by the customer are applied to payment intents and invoices. Valid options are `automatic`, `manual`, or `merchant_default`. For more information about these reconciliation modes, see [Reconciliation](https://stripe.com/docs/payments/customer-balance/reconciliation).
ReconciliationMode *string `form:"reconciliation_mode"`
}
type CashBalanceSettings struct {
// The configuration for how funds that land in the customer cash balance are reconciled.
ReconciliationMode CashBalanceSettingsReconciliationMode `json:"reconciliation_mode"`
// A flag to indicate if reconciliation mode returned is the user's default or is specific to this customer cash balance
UsingMerchantDefault bool `json:"using_merchant_default"`
}

// A customer's `Cash balance` represents real funds. Customers can add funds to their cash balance by sending a bank transfer. These funds can be used for payment and can eventually be paid out to your bank account.
Expand Down
4 changes: 2 additions & 2 deletions checkout_session.go
Original file line number Diff line number Diff line change
Expand Up @@ -1370,7 +1370,7 @@ type CheckoutSessionParams struct {
AutomaticTax *CheckoutSessionAutomaticTaxParams `form:"automatic_tax"`
// Specify whether Checkout should collect the customer's billing address.
BillingAddressCollection *string `form:"billing_address_collection"`
// The URL the customer will be directed to if they decide to cancel payment and return to your website.
// If set, Checkout displays a back button and customers will be directed to this URL if they decide to cancel payment and return to your website.
CancelURL *string `form:"cancel_url"`
// A unique string to reference the Checkout Session. This can be a
// customer ID, a cart ID, or similar, and can be used to reconcile the
Expand Down Expand Up @@ -2000,7 +2000,7 @@ type CheckoutSession struct {
AutomaticTax *CheckoutSessionAutomaticTax `json:"automatic_tax"`
// Describes whether Checkout should collect the customer's billing address.
BillingAddressCollection CheckoutSessionBillingAddressCollection `json:"billing_address_collection"`
// The URL the customer will be directed to if they decide to cancel payment and return to your website.
// If set, Checkout displays a back button and customers will be directed to this URL if they decide to cancel payment and return to your website.
CancelURL string `json:"cancel_url"`
// A unique string to reference the Checkout Session. This can be a
// customer ID, a cart ID, or similar, and can be used to reconcile the
Expand Down
2 changes: 0 additions & 2 deletions creditnote.go
Original file line number Diff line number Diff line change
Expand Up @@ -61,12 +61,10 @@ type CreditNoteLineParams struct {
// its amount_due. For a status=paid invoice, a credit note does not affect its amount_due. Instead, it can result
// in any combination of the following:
//
//
// Refund: create a new refund (using refund_amount) or link an existing refund (using refund).
// Customer balance credit: credit the customer's balance (using credit_amount) which will be automatically applied to their next invoice when it's finalized.
// Outside of Stripe credit: record the amount that is or will be credited outside of Stripe (using out_of_band_amount).
//
//
// For post-payment credit notes the sum of the refund, credit and outside of Stripe amounts must equal the credit note total.
//
// You may issue multiple credit notes for an invoice. Each credit note will increment the invoice's pre_payment_credit_notes_amount
Expand Down
2 changes: 1 addition & 1 deletion customer.go
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ type CustomerListParams struct {
// Settings controlling the behavior of the customer's cash balance,
// such as reconciliation of funds received.
type CustomerCashBalanceSettingsParams struct {
// Controls how funds transferred by the customer are applied to payment intents and invoices. Valid options are `automatic` or `manual`. For more information about these reconciliation modes, see [Reconciliation](https://stripe.com/docs/payments/customer-balance/reconciliation).
// Controls how funds transferred by the customer are applied to payment intents and invoices. Valid options are `automatic`, `manual`, or `merchant_default`. For more information about these reconciliation modes, see [Reconciliation](https://stripe.com/docs/payments/customer-balance/reconciliation).
ReconciliationMode *string `form:"reconciliation_mode"`
}

Expand Down
14 changes: 7 additions & 7 deletions financialconnections_account.go
Original file line number Diff line number Diff line change
Expand Up @@ -78,16 +78,16 @@ const (

// If `category` is `cash`, one of:
//
// - `checking`
// - `savings`
// - `other`
// - `checking`
// - `savings`
// - `other`
//
// If `category` is `credit`, one of:
//
// - `mortgage`
// - `line_of_credit`
// - `credit_card`
// - `other`
// - `mortgage`
// - `line_of_credit`
// - `credit_card`
// - `other`
//
// If `category` is `investment` or `other`, this will be `other`.
type FinancialConnectionsAccountSubcategory string
Expand Down
3 changes: 3 additions & 0 deletions paymentintent.go
Original file line number Diff line number Diff line change
Expand Up @@ -1078,13 +1078,16 @@ type PaymentIntentPaymentMethodOptionsCardPresentParams struct {
// Request ability to [increment](https://stripe.com/docs/terminal/features/incremental-authorizations) this PaymentIntent if the combination of MCC and card brand is eligible. Check [incremental_authorization_supported](https://stripe.com/docs/api/charges/object#charge_object-payment_method_details-card_present-incremental_authorization_supported) in the [Confirm](https://stripe.com/docs/api/payment_intents/confirm) response to verify support.
RequestIncrementalAuthorizationSupport *bool `form:"request_incremental_authorization_support"`
}

// Configuration for the eu_bank_transfer funding type.
type PaymentIntentPaymentMethodOptionsCustomerBalanceBankTransferEUBankTransferParams struct {
// The desired country code of the bank account information. Permitted values include: `DE`, `ES`, `FR`, `IE`, or `NL`.
Country *string `form:"country"`
}

// Configuration for the bank transfer funding type, if the `funding_type` is set to `bank_transfer`.
type PaymentIntentPaymentMethodOptionsCustomerBalanceBankTransferParams struct {
// Configuration for the eu_bank_transfer funding type.
EUBankTransfer *PaymentIntentPaymentMethodOptionsCustomerBalanceBankTransferEUBankTransferParams `form:"eu_bank_transfer"`
// List of address types that should be returned in the financial_addresses response. If not specified, all valid types will be returned.
//
Expand Down
5 changes: 3 additions & 2 deletions reporting_reportrun.go
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,9 @@
package stripe

// Status of this report run. This will be `pending` when the run is initially created.
// When the run finishes, this will be set to `succeeded` and the `result` field will be populated.
// Rarely, we may encounter an error, at which point this will be set to `failed` and the `error` field will be populated.
//
// When the run finishes, this will be set to `succeeded` and the `result` field will be populated.
// Rarely, we may encounter an error, at which point this will be set to `failed` and the `error` field will be populated.
type ReportingReportRunStatus string

// List of values that ReportingReportRunStatus can take
Expand Down
6 changes: 3 additions & 3 deletions subscriptionschedule.go
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ const (
SubscriptionScheduleDefaultSettingsBillingCycleAnchorPhaseStart SubscriptionScheduleDefaultSettingsBillingCycleAnchor = "phase_start"
)

// Behavior of the subscription schedule and underlying subscription when it ends. Possible values are `release` and `cancel`.
// 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.
type SubscriptionScheduleEndBehavior string

// List of values that SubscriptionScheduleEndBehavior can take
Expand Down Expand Up @@ -231,7 +231,7 @@ type SubscriptionScheduleParams struct {
Customer *string `form:"customer"`
// Object representing the subscription schedule's default settings.
DefaultSettings *SubscriptionScheduleDefaultSettingsParams `form:"default_settings"`
// Configures how the subscription schedule behaves 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.
// 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.
EndBehavior *string `form:"end_behavior"`
// 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.
FromSubscription *string `form:"from_subscription"`
Expand Down Expand Up @@ -395,7 +395,7 @@ type SubscriptionSchedule struct {
// ID of the customer who owns the subscription schedule.
Customer *Customer `json:"customer"`
DefaultSettings *SubscriptionScheduleDefaultSettings `json:"default_settings"`
// Behavior of the subscription schedule and underlying subscription when it ends. Possible values are `release` and `cancel`.
// 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.
EndBehavior SubscriptionScheduleEndBehavior `json:"end_behavior"`
// Unique identifier for the object.
ID string `json:"id"`
Expand Down