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 #1534

Merged
merged 2 commits into from
Aug 26, 2022
Merged
Show file tree
Hide file tree
Changes from 1 commit
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 @@
v184
v186
2 changes: 1 addition & 1 deletion types/2022-08-01/Accounts.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -421,7 +421,7 @@ declare module 'stripe' {
/**
* The company's legal name.
*/
name: string | null;
name?: string | null;

/**
* The Kana variation of the company's legal name (Japan only).
Expand Down
2 changes: 1 addition & 1 deletion types/2022-08-01/BankAccounts.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,7 @@ declare module 'stripe' {
/**
* Three-letter [ISO code for the currency](https://stripe.com/docs/payouts) paid out to the bank account.
*/
currency: string | null;
currency?: string | null;

/**
* Always true for a deleted object
Expand Down
42 changes: 42 additions & 0 deletions types/2022-08-01/BillingPortal/Configurations.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,8 @@ declare module 'stripe' {
*/
livemode: boolean;

login_page: Configuration.LoginPage;

/**
* Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
*/
Expand Down Expand Up @@ -238,6 +240,20 @@ declare module 'stripe' {
| 'none';
}
}

interface LoginPage {
/**
* If `true`, a shareable `url` will be generated that will take your customers to a hosted login page for the customer portal.
*
* If `false`, the previously generated `url`, if any, will be deactivated.
*/
enabled: boolean;

/**
* A shareable URL to the hosted portal login page. Your customers will be able to log in with their [email](https://stripe.com/docs/api/customers/object#customer_object-email) and receive a link to their customer portal.
*/
url: string | null;
}
}

interface ConfigurationCreateParams {
Expand All @@ -261,6 +277,11 @@ declare module 'stripe' {
*/
expand?: Array<string>;

/**
* The hosted login page for this configuration. Learn more about the portal login page in our [integration docs](https://stripe.com/docs/billing/subscriptions/integrating-customer-portal#share).
*/
login_page?: ConfigurationCreateParams.LoginPage;

/**
* Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
*/
Expand Down Expand Up @@ -462,6 +483,13 @@ declare module 'stripe' {
| 'none';
}
}

interface LoginPage {
/**
* Set to `true` to generate a shareable URL [`login_page.url`](https://stripe.com/docs/api/customer_portal/configuration#portal_configuration_object-login_page-url) that will take your customers to a hosted login page for the customer portal.
*/
enabled: boolean;
}
}

interface ConfigurationRetrieveParams {
Expand Down Expand Up @@ -497,6 +525,11 @@ declare module 'stripe' {
*/
features?: ConfigurationUpdateParams.Features;

/**
* The hosted login page for this configuration. Learn more about the portal login page in our [integration docs](https://stripe.com/docs/billing/subscriptions/integrating-customer-portal#share).
*/
login_page?: ConfigurationUpdateParams.LoginPage;

/**
* Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
*/
Expand Down Expand Up @@ -698,6 +731,15 @@ declare module 'stripe' {
| 'none';
}
}

interface LoginPage {
/**
* Set to `true` to generate a shareable URL [`login_page.url`](https://stripe.com/docs/api/customer_portal/configuration#portal_configuration_object-login_page-url) that will take your customers to a hosted login page for the customer portal.
*
* Set to `false` to deactivate the `login_page.url`.
*/
enabled: boolean;
}
}

interface ConfigurationListParams extends PaginationParams {
Expand Down
2 changes: 1 addition & 1 deletion types/2022-08-01/Cards.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -191,7 +191,7 @@ declare module 'stripe' {
/**
* Three-letter [ISO code for the currency](https://stripe.com/docs/payouts) paid out to the bank account.
*/
currency: string | null;
currency?: string | null;

/**
* Always true for a deleted object
Expand Down
5 changes: 3 additions & 2 deletions types/2022-08-01/Charges.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -204,7 +204,7 @@ declare module 'stripe' {
/**
* A list of refunds that have been applied to the charge.
*/
refunds: ApiList<Stripe.Refund>;
refunds?: ApiList<Stripe.Refund>;

/**
* ID of the review associated with this charge if one exists.
Expand Down Expand Up @@ -1125,7 +1125,7 @@ declare module 'stripe' {

interface Eps {
/**
* The customer's bank. Should be one of `arzte_und_apotheker_bank`, `austrian_anadi_bank_ag`, `bank_austria`, `bankhaus_carl_spangler`, `bankhaus_schelhammer_und_schattera_ag`, `bawag_psk_ag`, `bks_bank_ag`, `brull_kallmus_bank_ag`, `btv_vier_lander_bank`, `capital_bank_grawe_gruppe_ag`, `dolomitenbank`, `easybank_ag`, `erste_bank_und_sparkassen`, `hypo_alpeadriabank_international_ag`, `hypo_noe_lb_fur_niederosterreich_u_wien`, `hypo_oberosterreich_salzburg_steiermark`, `hypo_tirol_bank_ag`, `hypo_vorarlberg_bank_ag`, `hypo_bank_burgenland_aktiengesellschaft`, `marchfelder_bank`, `oberbank_ag`, `raiffeisen_bankengruppe_osterreich`, `schoellerbank_ag`, `sparda_bank_wien`, `volksbank_gruppe`, `volkskreditbank_ag`, or `vr_bank_braunau`.
* The customer's bank. Should be one of `arzte_und_apotheker_bank`, `austrian_anadi_bank_ag`, `bank_austria`, `bankhaus_carl_spangler`, `bankhaus_schelhammer_und_schattera_ag`, `bawag_psk_ag`, `bks_bank_ag`, `brull_kallmus_bank_ag`, `btv_vier_lander_bank`, `capital_bank_grawe_gruppe_ag`, `deutsche_bank_ag`, `dolomitenbank`, `easybank_ag`, `erste_bank_und_sparkassen`, `hypo_alpeadriabank_international_ag`, `hypo_noe_lb_fur_niederosterreich_u_wien`, `hypo_oberosterreich_salzburg_steiermark`, `hypo_tirol_bank_ag`, `hypo_vorarlberg_bank_ag`, `hypo_bank_burgenland_aktiengesellschaft`, `marchfelder_bank`, `oberbank_ag`, `raiffeisen_bankengruppe_osterreich`, `schoellerbank_ag`, `sparda_bank_wien`, `volksbank_gruppe`, `volkskreditbank_ag`, or `vr_bank_braunau`.
*/
bank: Eps.Bank | null;

Expand All @@ -1149,6 +1149,7 @@ declare module 'stripe' {
| 'brull_kallmus_bank_ag'
| 'btv_vier_lander_bank'
| 'capital_bank_grawe_gruppe_ag'
| 'deutsche_bank_ag'
| 'dolomitenbank'
| 'easybank_ag'
| 'erste_bank_und_sparkassen'
Expand Down
2 changes: 1 addition & 1 deletion types/2022-08-01/Invoices.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2944,7 +2944,7 @@ declare module 'stripe' {

class InvoicesResource {
/**
* This endpoint creates a draft invoice for a given customer. The draft invoice created pulls in all pending invoice items on that customer, including prorations. The invoice remains a draft until you [finalize the invoice, which allows you to [pay](#pay_invoice) or <a href="#send_invoice">send](https://stripe.com/docs/api#finalize_invoice) the invoice to your customers.
* This endpoint creates a draft invoice for a given customer. The invoice remains a draft until you [finalize the invoice, which allows you to [pay](#pay_invoice) or <a href="#send_invoice">send](https://stripe.com/docs/api#finalize_invoice) the invoice to your customers.
*/
create(
params?: InvoiceCreateParams,
Expand Down
34 changes: 34 additions & 0 deletions types/2022-08-01/Issuing/Cards.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -135,6 +135,11 @@ declare module 'stripe' {
*/
carrier: Shipping.Carrier | null;

/**
* Additional information that may be required for clearing customs.
*/
customs: Shipping.Customs | null;

/**
* A unix timestamp representing a best estimate of when the card will be delivered.
*/
Expand All @@ -145,6 +150,11 @@ declare module 'stripe' {
*/
name: string;

/**
* The phone number of the receiver of the bulk shipment. This phone number will be provided to the shipping company, who might use it to contact the receiver in case of delivery issues.
*/
phone_number: string | null;

/**
* Shipment service, such as `standard` or `express`.
*/
Expand Down Expand Up @@ -174,6 +184,13 @@ declare module 'stripe' {
namespace Shipping {
type Carrier = 'dhl' | 'fedex' | 'royal_mail' | 'usps';

interface Customs {
/**
* A registration number used for customs in Europe. See https://www.gov.uk/eori and https://ec.europa.eu/taxation_customs/business/customs-procedures-import-and-export/customs-procedures/economic-operators-registration-and-identification-number-eori_en.
*/
eori_number: string | null;
}

type Service = 'express' | 'priority' | 'standard';

type Status =
Expand Down Expand Up @@ -1227,11 +1244,21 @@ declare module 'stripe' {
*/
address: Shipping.Address;

/**
* Customs information for the shipment.
*/
customs?: Shipping.Customs;

/**
* The name printed on the shipping label when shipping the card.
*/
name: string;

/**
* Phone number of the recipient of the shipment.
*/
phone_number?: string;

/**
* Shipment service.
*/
Expand Down Expand Up @@ -1276,6 +1303,13 @@ declare module 'stripe' {
state?: string;
}

interface Customs {
/**
* The Economic Operators Registration and Identification (EORI) number to use for Customs. Required for bulk shipments to Europe.
*/
eori_number?: string;
}

type Service = 'express' | 'priority' | 'standard';

type Type = 'bulk' | 'individual';
Expand Down
5 changes: 4 additions & 1 deletion types/2022-08-01/PaymentIntents.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ declare module 'stripe' {
/**
* Charges that were created by this PaymentIntent, if any.
*/
charges: ApiList<Stripe.Charge>;
charges?: ApiList<Stripe.Charge>;

/**
* The client secret of this PaymentIntent. Used for client-side retrieval using a publishable key.
Expand Down Expand Up @@ -2229,6 +2229,7 @@ declare module 'stripe' {
| 'brull_kallmus_bank_ag'
| 'btv_vier_lander_bank'
| 'capital_bank_grawe_gruppe_ag'
| 'deutsche_bank_ag'
| 'dolomitenbank'
| 'easybank_ag'
| 'erste_bank_und_sparkassen'
Expand Down Expand Up @@ -3941,6 +3942,7 @@ declare module 'stripe' {
| 'brull_kallmus_bank_ag'
| 'btv_vier_lander_bank'
| 'capital_bank_grawe_gruppe_ag'
| 'deutsche_bank_ag'
| 'dolomitenbank'
| 'easybank_ag'
| 'erste_bank_und_sparkassen'
Expand Down Expand Up @@ -5788,6 +5790,7 @@ declare module 'stripe' {
| 'brull_kallmus_bank_ag'
| 'btv_vier_lander_bank'
| 'capital_bank_grawe_gruppe_ag'
| 'deutsche_bank_ag'
| 'dolomitenbank'
| 'easybank_ag'
| 'erste_bank_und_sparkassen'
Expand Down
4 changes: 3 additions & 1 deletion types/2022-08-01/PaymentMethods.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -416,7 +416,7 @@ declare module 'stripe' {

interface Eps {
/**
* The customer's bank. Should be one of `arzte_und_apotheker_bank`, `austrian_anadi_bank_ag`, `bank_austria`, `bankhaus_carl_spangler`, `bankhaus_schelhammer_und_schattera_ag`, `bawag_psk_ag`, `bks_bank_ag`, `brull_kallmus_bank_ag`, `btv_vier_lander_bank`, `capital_bank_grawe_gruppe_ag`, `dolomitenbank`, `easybank_ag`, `erste_bank_und_sparkassen`, `hypo_alpeadriabank_international_ag`, `hypo_noe_lb_fur_niederosterreich_u_wien`, `hypo_oberosterreich_salzburg_steiermark`, `hypo_tirol_bank_ag`, `hypo_vorarlberg_bank_ag`, `hypo_bank_burgenland_aktiengesellschaft`, `marchfelder_bank`, `oberbank_ag`, `raiffeisen_bankengruppe_osterreich`, `schoellerbank_ag`, `sparda_bank_wien`, `volksbank_gruppe`, `volkskreditbank_ag`, or `vr_bank_braunau`.
* The customer's bank. Should be one of `arzte_und_apotheker_bank`, `austrian_anadi_bank_ag`, `bank_austria`, `bankhaus_carl_spangler`, `bankhaus_schelhammer_und_schattera_ag`, `bawag_psk_ag`, `bks_bank_ag`, `brull_kallmus_bank_ag`, `btv_vier_lander_bank`, `capital_bank_grawe_gruppe_ag`, `deutsche_bank_ag`, `dolomitenbank`, `easybank_ag`, `erste_bank_und_sparkassen`, `hypo_alpeadriabank_international_ag`, `hypo_noe_lb_fur_niederosterreich_u_wien`, `hypo_oberosterreich_salzburg_steiermark`, `hypo_tirol_bank_ag`, `hypo_vorarlberg_bank_ag`, `hypo_bank_burgenland_aktiengesellschaft`, `marchfelder_bank`, `oberbank_ag`, `raiffeisen_bankengruppe_osterreich`, `schoellerbank_ag`, `sparda_bank_wien`, `volksbank_gruppe`, `volkskreditbank_ag`, or `vr_bank_braunau`.
*/
bank: Eps.Bank | null;
}
Expand All @@ -433,6 +433,7 @@ declare module 'stripe' {
| 'brull_kallmus_bank_ag'
| 'btv_vier_lander_bank'
| 'capital_bank_grawe_gruppe_ag'
| 'deutsche_bank_ag'
| 'dolomitenbank'
| 'easybank_ag'
| 'erste_bank_und_sparkassen'
Expand Down Expand Up @@ -1086,6 +1087,7 @@ declare module 'stripe' {
| 'brull_kallmus_bank_ag'
| 'btv_vier_lander_bank'
| 'capital_bank_grawe_gruppe_ag'
| 'deutsche_bank_ag'
| 'dolomitenbank'
| 'easybank_ag'
| 'erste_bank_und_sparkassen'
Expand Down
6 changes: 3 additions & 3 deletions types/2022-08-01/Products.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ declare module 'stripe' {
/**
* A short one-line description of the product, meant to be displayable to the customer. Only applicable to products of `type=good`.
*/
caption: string | null;
caption?: string | null;

/**
* Time at which the object was created. Measured in seconds since the Unix epoch.
Expand Down Expand Up @@ -93,7 +93,7 @@ declare module 'stripe' {
/**
* Extra information about a product which will appear on your customer's credit card statement. In the case that multiple products are billed at once, the first statement descriptor will be used.
*/
statement_descriptor: string | null;
statement_descriptor?: string | null;

/**
* A [tax code](https://stripe.com/docs/tax/tax-categories) ID.
Expand All @@ -108,7 +108,7 @@ declare module 'stripe' {
/**
* A label that represents units of this product in Stripe and on customers' receipts and invoices. When set, this will be included in associated invoice line item descriptions.
*/
unit_label: string | null;
unit_label?: string | null;

/**
* Time at which the object was last updated. Measured in seconds since the Unix epoch.
Expand Down
15 changes: 15 additions & 0 deletions types/2022-08-01/Quotes.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -418,6 +418,11 @@ declare module 'stripe' {
}

interface SubscriptionData {
/**
* The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription.
*/
description: string | null;

/**
* When creating a new subscription, the date of which the subscription schedule will start after the quote is accepted. This date is ignored if it is in the past when the quote is accepted. Measured in seconds since the Unix epoch.
*/
Expand Down Expand Up @@ -731,6 +736,11 @@ declare module 'stripe' {
}

interface SubscriptionData {
/**
* The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription.
*/
description?: string;

/**
* When creating a new subscription, the date of which the subscription schedule will start after the quote is accepted. When updating a subscription, the date of which the subscription will be updated using a subscription schedule. The special value `current_period_end` can be provided to update a subscription at the end of its current period. The `effective_date` is ignored if it is in the past when the quote is accepted.
*/
Expand Down Expand Up @@ -970,6 +980,11 @@ declare module 'stripe' {
}

interface SubscriptionData {
/**
* The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription.
*/
description?: string;

/**
* When creating a new subscription, the date of which the subscription schedule will start after the quote is accepted. When updating a subscription, the date of which the subscription will be updated using a subscription schedule. The special value `current_period_end` can be provided to update a subscription at the end of its current period. The `effective_date` is ignored if it is in the past when the quote is accepted.
*/
Expand Down
3 changes: 3 additions & 0 deletions types/2022-08-01/SetupIntents.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -985,6 +985,7 @@ declare module 'stripe' {
| 'brull_kallmus_bank_ag'
| 'btv_vier_lander_bank'
| 'capital_bank_grawe_gruppe_ag'
| 'deutsche_bank_ag'
| 'dolomitenbank'
| 'easybank_ag'
| 'erste_bank_und_sparkassen'
Expand Down Expand Up @@ -1851,6 +1852,7 @@ declare module 'stripe' {
| 'brull_kallmus_bank_ag'
| 'btv_vier_lander_bank'
| 'capital_bank_grawe_gruppe_ag'
| 'deutsche_bank_ag'
| 'dolomitenbank'
| 'easybank_ag'
| 'erste_bank_und_sparkassen'
Expand Down Expand Up @@ -2799,6 +2801,7 @@ declare module 'stripe' {
| 'brull_kallmus_bank_ag'
| 'btv_vier_lander_bank'
| 'capital_bank_grawe_gruppe_ag'
| 'deutsche_bank_ag'
| 'dolomitenbank'
| 'easybank_ag'
| 'erste_bank_und_sparkassen'
Expand Down
Loading