Class ShippingRatesResource

Index

Constructors

Methods

create retrieve update list

Constructors

constructor

new ShippingRatesResource(): ShippingRatesResource
Returns ShippingRatesResource

Methods

create

create(
params: Stripe.ShippingRateCreateParams,
options?: RequestOptions,
): Promise<Response<Stripe.ShippingRate>>
Creates a new shipping rate object.
Parameters
- params: Stripe.ShippingRateCreateParams
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.ShippingRate>>
- Defined in node_modules/stripe/types/ShippingRatesResource.d.ts:225

retrieve

retrieve(
    id: string,
    params?: ShippingRateRetrieveParams,
    options?: RequestOptions,
): Promise<Response<Stripe.ShippingRate>>
Returns the shipping rate object with the given ID.
Parameters
- id: string
- Optionalparams: ShippingRateRetrieveParams
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.ShippingRate>>
- Defined in node_modules/stripe/types/ShippingRatesResource.d.ts:233
retrieve(
id: string,
options?: RequestOptions,
): Promise<Response<Stripe.ShippingRate>>
Returns the shipping rate object with the given ID.
Parameters
- id: string
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.ShippingRate>>
- Defined in node_modules/stripe/types/ShippingRatesResource.d.ts:238

update

update(
    id: string,
    params?: Stripe.ShippingRateUpdateParams,
    options?: RequestOptions,
): Promise<Response<Stripe.ShippingRate>>
Updates an existing shipping rate object.
Parameters
- id: string
- Optionalparams: Stripe.ShippingRateUpdateParams
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.ShippingRate>>
- Defined in node_modules/stripe/types/ShippingRatesResource.d.ts:246

list

list(
params?: ShippingRateListParams,
options?: RequestOptions,
): ApiListPromise<Stripe.ShippingRate>
Returns a list of your shipping rates.
Parameters
- Optionalparams: ShippingRateListParams
- Optionaloptions: RequestOptions
Returns ApiListPromise<Stripe.ShippingRate>
- Defined in node_modules/stripe/types/ShippingRatesResource.d.ts:255
list(options?: RequestOptions): ApiListPromise<Stripe.ShippingRate>
Returns a list of your shipping rates.
Parameters
- Optionaloptions: RequestOptions
Returns ApiListPromise<Stripe.ShippingRate>
- Defined in node_modules/stripe/types/ShippingRatesResource.d.ts:259