Class CreditGrantsResource

Index

Constructors

constructor

Methods

create retrieve update list expire voidGrant

Constructors

constructor

new CreditGrantsResource(): CreditGrantsResource
Returns CreditGrantsResource

Methods

create

create(
params: Stripe.Billing.CreditGrantCreateParams,
options?: RequestOptions,
): Promise<Response<Stripe.Billing.CreditGrant>>
Creates a credit grant.
Parameters
- params: Stripe.Billing.CreditGrantCreateParams
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.Billing.CreditGrant>>
- Defined in node_modules/stripe/types/Billing/CreditGrantsResource.d.ts:182

retrieve

retrieve(
    id: string,
    params?: CreditGrantRetrieveParams,
    options?: RequestOptions,
): Promise<Response<Stripe.Billing.CreditGrant>>
Retrieves a credit grant.
Parameters
- id: string
- Optionalparams: CreditGrantRetrieveParams
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.Billing.CreditGrant>>
- Defined in node_modules/stripe/types/Billing/CreditGrantsResource.d.ts:190
retrieve(
id: string,
options?: RequestOptions,
): Promise<Response<Stripe.Billing.CreditGrant>>
Retrieves a credit grant.
Parameters
- id: string
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.Billing.CreditGrant>>
- Defined in node_modules/stripe/types/Billing/CreditGrantsResource.d.ts:195

update

update(
    id: string,
    params?: CreditGrantUpdateParams,
    options?: RequestOptions,
): Promise<Response<Stripe.Billing.CreditGrant>>
Updates a credit grant.
Parameters
- id: string
- Optionalparams: CreditGrantUpdateParams
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.Billing.CreditGrant>>
- Defined in node_modules/stripe/types/Billing/CreditGrantsResource.d.ts:203

list

list(
params?: CreditGrantListParams,
options?: RequestOptions,
): ApiListPromise<Stripe.Billing.CreditGrant>
Retrieve a list of credit grants.
Parameters
- Optionalparams: CreditGrantListParams
- Optionaloptions: RequestOptions
Returns ApiListPromise<Stripe.Billing.CreditGrant>
- Defined in node_modules/stripe/types/Billing/CreditGrantsResource.d.ts:212
list(options?: RequestOptions): ApiListPromise<Stripe.Billing.CreditGrant>
Retrieve a list of credit grants.
Parameters
- Optionaloptions: RequestOptions
Returns ApiListPromise<Stripe.Billing.CreditGrant>
- Defined in node_modules/stripe/types/Billing/CreditGrantsResource.d.ts:216

expire

expire(
    id: string,
    params?: CreditGrantExpireParams,
    options?: RequestOptions,
): Promise<Response<Stripe.Billing.CreditGrant>>
Expires a credit grant.
Parameters
- id: string
- Optionalparams: CreditGrantExpireParams
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.Billing.CreditGrant>>
- Defined in node_modules/stripe/types/Billing/CreditGrantsResource.d.ts:223
expire(
id: string,
options?: RequestOptions,
): Promise<Response<Stripe.Billing.CreditGrant>>
Expires a credit grant.
Parameters
- id: string
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.Billing.CreditGrant>>
- Defined in node_modules/stripe/types/Billing/CreditGrantsResource.d.ts:228

voidGrant

voidGrant(
    id: string,
    params?: CreditGrantVoidGrantParams,
    options?: RequestOptions,
): Promise<Response<Stripe.Billing.CreditGrant>>
Voids a credit grant.
Parameters
- id: string
- Optionalparams: CreditGrantVoidGrantParams
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.Billing.CreditGrant>>
- Defined in node_modules/stripe/types/Billing/CreditGrantsResource.d.ts:236
voidGrant(
id: string,
options?: RequestOptions,
): Promise<Response<Stripe.Billing.CreditGrant>>
Voids a credit grant.
Parameters
- id: string
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.Billing.CreditGrant>>
- Defined in node_modules/stripe/types/Billing/CreditGrantsResource.d.ts:241

Class CreditGrantsResource

Index

Constructors

Methods

Constructors

constructor

Returns CreditGrantsResource

Methods

create

Parameters

Returns Promise<Response<Stripe.Billing.CreditGrant>>

retrieve

Parameters

Returns Promise<Response<Stripe.Billing.CreditGrant>>

Parameters

Returns Promise<Response<Stripe.Billing.CreditGrant>>

update

Parameters

Returns Promise<Response<Stripe.Billing.CreditGrant>>

list

Parameters

Returns ApiListPromise<Stripe.Billing.CreditGrant>

Parameters

Returns ApiListPromise<Stripe.Billing.CreditGrant>

expire

Parameters

Returns Promise<Response<Stripe.Billing.CreditGrant>>

Parameters

Returns Promise<Response<Stripe.Billing.CreditGrant>>

voidGrant

Parameters

Returns Promise<Response<Stripe.Billing.CreditGrant>>

Parameters

Returns Promise<Response<Stripe.Billing.CreditGrant>>

Settings

On This Page