orb-billing
Version:
The official TypeScript library for the Orb API
102 lines • 4.5 kB
TypeScript
import { APIResource } from "../../core/resource.js";
import { APIPromise } from "../../core/api-promise.js";
import { Page, type PageParams, PagePromise } from "../../core/pagination.js";
import { RequestOptions } from "../../internal/request-options.js";
/**
* The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be subscribed to by a
* customer. Plans define the billing behavior of the subscription. You can see more about how to configure prices
* in the [Price resource](/reference/price).
*/
export declare class Migrations extends APIResource {
/**
* Fetch migration
*/
retrieve(migrationID: string, params: MigrationRetrieveParams, options?: RequestOptions): APIPromise<MigrationRetrieveResponse>;
/**
* This endpoint returns a list of all migrations for a plan. The list of
* migrations is ordered starting from the most recently created migration. The
* response also includes pagination_metadata, which lets the caller retrieve the
* next page of results if they exist.
*/
list(planID: string, query?: MigrationListParams | null | undefined, options?: RequestOptions): PagePromise<MigrationListResponsesPage, MigrationListResponse>;
/**
* This endpoint cancels a migration.
*/
cancel(migrationID: string, params: MigrationCancelParams, options?: RequestOptions): APIPromise<MigrationCancelResponse>;
}
export type MigrationListResponsesPage = Page<MigrationListResponse>;
export interface MigrationRetrieveResponse {
/**
* Unique identifier for this plan version change.
*/
id: string;
/**
* When the migration takes effect. Can be a specific date/time, 'end_of_term' when
* scheduled to be at the end of the current billing period, or 'end_of_invoice'
* when scheduled to be at the start of the next invoice.
*/
effective_time: (string & {}) | (string & {}) | 'end_of_term' | 'end_of_invoice' | null;
/**
* The ID of the plan being migrated.
*/
plan_id: string;
/**
* Current status of the migration: 'not_started', 'in_progress', 'completed',
* 'action_needed', or 'canceled'.
*/
status: 'not_started' | 'in_progress' | 'completed' | 'action_needed' | 'canceled';
}
export interface MigrationListResponse {
/**
* Unique identifier for this plan version change.
*/
id: string;
/**
* When the migration takes effect. Can be a specific date/time, 'end_of_term' when
* scheduled to be at the end of the current billing period, or 'end_of_invoice'
* when scheduled to be at the start of the next invoice.
*/
effective_time: (string & {}) | (string & {}) | 'end_of_term' | 'end_of_invoice' | null;
/**
* The ID of the plan being migrated.
*/
plan_id: string;
/**
* Current status of the migration: 'not_started', 'in_progress', 'completed',
* 'action_needed', or 'canceled'.
*/
status: 'not_started' | 'in_progress' | 'completed' | 'action_needed' | 'canceled';
}
export interface MigrationCancelResponse {
/**
* Unique identifier for this plan version change.
*/
id: string;
/**
* When the migration takes effect. Can be a specific date/time, 'end_of_term' when
* scheduled to be at the end of the current billing period, or 'end_of_invoice'
* when scheduled to be at the start of the next invoice.
*/
effective_time: (string & {}) | (string & {}) | 'end_of_term' | 'end_of_invoice' | null;
/**
* The ID of the plan being migrated.
*/
plan_id: string;
/**
* Current status of the migration: 'not_started', 'in_progress', 'completed',
* 'action_needed', or 'canceled'.
*/
status: 'not_started' | 'in_progress' | 'completed' | 'action_needed' | 'canceled';
}
export interface MigrationRetrieveParams {
plan_id: string;
}
export interface MigrationListParams extends PageParams {
}
export interface MigrationCancelParams {
plan_id: string;
}
export declare namespace Migrations {
export { type MigrationRetrieveResponse as MigrationRetrieveResponse, type MigrationListResponse as MigrationListResponse, type MigrationCancelResponse as MigrationCancelResponse, type MigrationListResponsesPage as MigrationListResponsesPage, type MigrationRetrieveParams as MigrationRetrieveParams, type MigrationListParams as MigrationListParams, type MigrationCancelParams as MigrationCancelParams, };
}
//# sourceMappingURL=migrations.d.ts.map