@getopenpay/client
Version:
OpenPay API TypeScript SDK
70 lines (69 loc) • 2.43 kB
TypeScript
/**
* OpenPay API
* super charge your subscription management.
*
* The version of the OpenAPI document: 1.2.1
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
import type { ProrationEnum } from './ProrationEnum';
/**
*
* @export
* @interface CreateSubscriptionItemRequest
*/
export interface CreateSubscriptionItemRequest {
/**
* If the flag is set to True, item will be added when renewing the subscription at next billing cycle.
* @type {boolean}
* @memberof CreateSubscriptionItemRequest
*/
addAtPeriodEnd?: boolean;
/**
*
* @type {object}
* @memberof CreateSubscriptionItemRequest
*/
customFields?: object | null;
/**
*
* @type {string}
* @memberof CreateSubscriptionItemRequest
*/
description?: string | null;
/**
* The ID of the price.
* @type {string}
* @memberof CreateSubscriptionItemRequest
*/
priceId: string;
/**
* Determines how to handle prorations when the billable items changes.In case of subscription is in trialing state, invoice items if any will be for amount_atom 0.
* @type {ProrationEnum}
* @memberof CreateSubscriptionItemRequest
*/
prorationBehavior?: ProrationEnum;
/**
* The quantity you'd like to apply to the subscription item you're creating.
* @type {number}
* @memberof CreateSubscriptionItemRequest
*/
quantity?: number;
/**
* The identifier of the subscription to modify
* @type {string}
* @memberof CreateSubscriptionItemRequest
*/
subscriptionId: string;
}
/**
* Check if a given object implements the CreateSubscriptionItemRequest interface.
*/
export declare function instanceOfCreateSubscriptionItemRequest(value: object): value is CreateSubscriptionItemRequest;
export declare function CreateSubscriptionItemRequestFromJSON(json: any): CreateSubscriptionItemRequest;
export declare function CreateSubscriptionItemRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateSubscriptionItemRequest;
export declare function CreateSubscriptionItemRequestToJSON(json: any): CreateSubscriptionItemRequest;
export declare function CreateSubscriptionItemRequestToJSONTyped(value?: CreateSubscriptionItemRequest | null, ignoreDiscriminator?: boolean): any;