@seekora-ai/admin-api 1.2.4 → 1.2.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +14 -2
- package/api.ts +725 -8
- package/dist/api.d.ts +433 -4
- package/dist/api.js +508 -14
- package/dist/esm/api.d.ts +433 -4
- package/dist/esm/api.js +502 -8
- package/package.json +1 -1
- package/seekora-ai-admin-api-1.2.5.tgz +0 -0
- package/seekora-ai-admin-api-1.2.4.tgz +0 -0
package/dist/esm/api.d.ts
CHANGED
|
@@ -14969,6 +14969,7 @@ export declare const DataTypesCreatePaymentOrderRequestPaymentTypeEnum: {
|
|
|
14969
14969
|
readonly Generic: "generic";
|
|
14970
14970
|
readonly Subscription: "subscription";
|
|
14971
14971
|
readonly CreditTopup: "credit_topup";
|
|
14972
|
+
readonly PlanChange: "plan_change";
|
|
14972
14973
|
};
|
|
14973
14974
|
export type DataTypesCreatePaymentOrderRequestPaymentTypeEnum = typeof DataTypesCreatePaymentOrderRequestPaymentTypeEnum[keyof typeof DataTypesCreatePaymentOrderRequestPaymentTypeEnum];
|
|
14974
14975
|
/**
|
|
@@ -16099,6 +16100,12 @@ export interface DataTypesCurrentPlanInfo {
|
|
|
16099
16100
|
* @memberof DataTypesCurrentPlanInfo
|
|
16100
16101
|
*/
|
|
16101
16102
|
'billing_cycle'?: string;
|
|
16103
|
+
/**
|
|
16104
|
+
* Currency of the subscription (INR, USD)
|
|
16105
|
+
* @type {string}
|
|
16106
|
+
* @memberof DataTypesCurrentPlanInfo
|
|
16107
|
+
*/
|
|
16108
|
+
'currency_code'?: string;
|
|
16102
16109
|
/**
|
|
16103
16110
|
*
|
|
16104
16111
|
* @type {string}
|
|
@@ -22377,6 +22384,18 @@ export interface DataTypesInvoice {
|
|
|
22377
22384
|
* @memberof DataTypesInvoice
|
|
22378
22385
|
*/
|
|
22379
22386
|
'created_at'?: string;
|
|
22387
|
+
/**
|
|
22388
|
+
*
|
|
22389
|
+
* @type {string}
|
|
22390
|
+
* @memberof DataTypesInvoice
|
|
22391
|
+
*/
|
|
22392
|
+
'credit_note_reason'?: string;
|
|
22393
|
+
/**
|
|
22394
|
+
*
|
|
22395
|
+
* @type {string}
|
|
22396
|
+
* @memberof DataTypesInvoice
|
|
22397
|
+
*/
|
|
22398
|
+
'credit_note_status'?: string;
|
|
22380
22399
|
/**
|
|
22381
22400
|
*
|
|
22382
22401
|
* @type {string}
|
|
@@ -22413,6 +22432,12 @@ export interface DataTypesInvoice {
|
|
|
22413
22432
|
* @memberof DataTypesInvoice
|
|
22414
22433
|
*/
|
|
22415
22434
|
'invoice_pdf_url'?: string;
|
|
22435
|
+
/**
|
|
22436
|
+
* Credit note fields (only populated when invoice_type = \'credit_note\')
|
|
22437
|
+
* @type {string}
|
|
22438
|
+
* @memberof DataTypesInvoice
|
|
22439
|
+
*/
|
|
22440
|
+
'invoice_type'?: string;
|
|
22416
22441
|
/**
|
|
22417
22442
|
*
|
|
22418
22443
|
* @type {string}
|
|
@@ -22453,6 +22478,18 @@ export interface DataTypesInvoice {
|
|
|
22453
22478
|
* @memberof DataTypesInvoice
|
|
22454
22479
|
*/
|
|
22455
22480
|
'org_name'?: string;
|
|
22481
|
+
/**
|
|
22482
|
+
*
|
|
22483
|
+
* @type {string}
|
|
22484
|
+
* @memberof DataTypesInvoice
|
|
22485
|
+
*/
|
|
22486
|
+
'original_invoice_id'?: string;
|
|
22487
|
+
/**
|
|
22488
|
+
*
|
|
22489
|
+
* @type {string}
|
|
22490
|
+
* @memberof DataTypesInvoice
|
|
22491
|
+
*/
|
|
22492
|
+
'original_invoice_number'?: string;
|
|
22456
22493
|
/**
|
|
22457
22494
|
*
|
|
22458
22495
|
* @type {string}
|
|
@@ -22495,6 +22532,12 @@ export interface DataTypesInvoice {
|
|
|
22495
22532
|
* @memberof DataTypesInvoice
|
|
22496
22533
|
*/
|
|
22497
22534
|
'receipt_pdf_url'?: string;
|
|
22535
|
+
/**
|
|
22536
|
+
*
|
|
22537
|
+
* @type {number}
|
|
22538
|
+
* @memberof DataTypesInvoice
|
|
22539
|
+
*/
|
|
22540
|
+
'refund_request_id'?: number;
|
|
22498
22541
|
/**
|
|
22499
22542
|
* \"draft\", \"sent\", \"paid\", \"overdue\", \"cancelled\"
|
|
22500
22543
|
* @type {string}
|
|
@@ -22531,6 +22574,12 @@ export interface DataTypesInvoice {
|
|
|
22531
22574
|
* @memberof DataTypesInvoice
|
|
22532
22575
|
*/
|
|
22533
22576
|
'updated_at'?: string;
|
|
22577
|
+
/**
|
|
22578
|
+
*
|
|
22579
|
+
* @type {string}
|
|
22580
|
+
* @memberof DataTypesInvoice
|
|
22581
|
+
*/
|
|
22582
|
+
'voided_at'?: string;
|
|
22534
22583
|
}
|
|
22535
22584
|
/**
|
|
22536
22585
|
*
|
|
@@ -30063,6 +30112,93 @@ export interface DataTypesSendNotificationResponse {
|
|
|
30063
30112
|
*/
|
|
30064
30113
|
'status'?: number;
|
|
30065
30114
|
}
|
|
30115
|
+
/**
|
|
30116
|
+
*
|
|
30117
|
+
* @export
|
|
30118
|
+
* @interface DataTypesSendOrgNotificationData
|
|
30119
|
+
*/
|
|
30120
|
+
export interface DataTypesSendOrgNotificationData {
|
|
30121
|
+
/**
|
|
30122
|
+
*
|
|
30123
|
+
* @type {string}
|
|
30124
|
+
* @memberof DataTypesSendOrgNotificationData
|
|
30125
|
+
*/
|
|
30126
|
+
'scope'?: string;
|
|
30127
|
+
/**
|
|
30128
|
+
*
|
|
30129
|
+
* @type {number}
|
|
30130
|
+
* @memberof DataTypesSendOrgNotificationData
|
|
30131
|
+
*/
|
|
30132
|
+
'sent_count'?: number;
|
|
30133
|
+
}
|
|
30134
|
+
/**
|
|
30135
|
+
*
|
|
30136
|
+
* @export
|
|
30137
|
+
* @interface DataTypesSendOrgNotificationRequest
|
|
30138
|
+
*/
|
|
30139
|
+
export interface DataTypesSendOrgNotificationRequest {
|
|
30140
|
+
/**
|
|
30141
|
+
*
|
|
30142
|
+
* @type {Array<DataTypesNotificationChannel>}
|
|
30143
|
+
* @memberof DataTypesSendOrgNotificationRequest
|
|
30144
|
+
*/
|
|
30145
|
+
'channels'?: Array<DataTypesNotificationChannel>;
|
|
30146
|
+
/**
|
|
30147
|
+
*
|
|
30148
|
+
* @type {string}
|
|
30149
|
+
* @memberof DataTypesSendOrgNotificationRequest
|
|
30150
|
+
*/
|
|
30151
|
+
'message'?: string;
|
|
30152
|
+
/**
|
|
30153
|
+
*
|
|
30154
|
+
* @type {DataTypesNotificationPriority}
|
|
30155
|
+
* @memberof DataTypesSendOrgNotificationRequest
|
|
30156
|
+
*/
|
|
30157
|
+
'priority'?: DataTypesNotificationPriority;
|
|
30158
|
+
/**
|
|
30159
|
+
* \"all\" | \"owners_admins\"
|
|
30160
|
+
* @type {string}
|
|
30161
|
+
* @memberof DataTypesSendOrgNotificationRequest
|
|
30162
|
+
*/
|
|
30163
|
+
'scope'?: string;
|
|
30164
|
+
/**
|
|
30165
|
+
*
|
|
30166
|
+
* @type {string}
|
|
30167
|
+
* @memberof DataTypesSendOrgNotificationRequest
|
|
30168
|
+
*/
|
|
30169
|
+
'title'?: string;
|
|
30170
|
+
/**
|
|
30171
|
+
*
|
|
30172
|
+
* @type {DataTypesNotificationType}
|
|
30173
|
+
* @memberof DataTypesSendOrgNotificationRequest
|
|
30174
|
+
*/
|
|
30175
|
+
'type'?: DataTypesNotificationType;
|
|
30176
|
+
}
|
|
30177
|
+
/**
|
|
30178
|
+
*
|
|
30179
|
+
* @export
|
|
30180
|
+
* @interface DataTypesSendOrgNotificationResponse
|
|
30181
|
+
*/
|
|
30182
|
+
export interface DataTypesSendOrgNotificationResponse {
|
|
30183
|
+
/**
|
|
30184
|
+
*
|
|
30185
|
+
* @type {DataTypesSendOrgNotificationData}
|
|
30186
|
+
* @memberof DataTypesSendOrgNotificationResponse
|
|
30187
|
+
*/
|
|
30188
|
+
'data'?: DataTypesSendOrgNotificationData;
|
|
30189
|
+
/**
|
|
30190
|
+
*
|
|
30191
|
+
* @type {string}
|
|
30192
|
+
* @memberof DataTypesSendOrgNotificationResponse
|
|
30193
|
+
*/
|
|
30194
|
+
'message'?: string;
|
|
30195
|
+
/**
|
|
30196
|
+
*
|
|
30197
|
+
* @type {number}
|
|
30198
|
+
* @memberof DataTypesSendOrgNotificationResponse
|
|
30199
|
+
*/
|
|
30200
|
+
'status'?: number;
|
|
30201
|
+
}
|
|
30066
30202
|
/**
|
|
30067
30203
|
*
|
|
30068
30204
|
* @export
|
|
@@ -40506,6 +40642,31 @@ export interface SubscriptionRouteCancelProcessRequest {
|
|
|
40506
40642
|
*/
|
|
40507
40643
|
'subscription_id'?: string;
|
|
40508
40644
|
}
|
|
40645
|
+
/**
|
|
40646
|
+
*
|
|
40647
|
+
* @export
|
|
40648
|
+
* @interface SubscriptionRouteImmediatePlanChangeOrderHTTPRequest
|
|
40649
|
+
*/
|
|
40650
|
+
export interface SubscriptionRouteImmediatePlanChangeOrderHTTPRequest {
|
|
40651
|
+
/**
|
|
40652
|
+
*
|
|
40653
|
+
* @type {string}
|
|
40654
|
+
* @memberof SubscriptionRouteImmediatePlanChangeOrderHTTPRequest
|
|
40655
|
+
*/
|
|
40656
|
+
'billing_cycle'?: string;
|
|
40657
|
+
/**
|
|
40658
|
+
*
|
|
40659
|
+
* @type {string}
|
|
40660
|
+
* @memberof SubscriptionRouteImmediatePlanChangeOrderHTTPRequest
|
|
40661
|
+
*/
|
|
40662
|
+
'currency'?: string;
|
|
40663
|
+
/**
|
|
40664
|
+
*
|
|
40665
|
+
* @type {string}
|
|
40666
|
+
* @memberof SubscriptionRouteImmediatePlanChangeOrderHTTPRequest
|
|
40667
|
+
*/
|
|
40668
|
+
'new_plan_identifier'?: string;
|
|
40669
|
+
}
|
|
40509
40670
|
/**
|
|
40510
40671
|
*
|
|
40511
40672
|
* @export
|
|
@@ -40537,6 +40698,31 @@ export interface SubscriptionRoutePlanChangePreviewHTTPRequest {
|
|
|
40537
40698
|
*/
|
|
40538
40699
|
'new_plan_identifier'?: string;
|
|
40539
40700
|
}
|
|
40701
|
+
/**
|
|
40702
|
+
*
|
|
40703
|
+
* @export
|
|
40704
|
+
* @interface SubscriptionRouteSchedulePlanChangeHTTPRequest
|
|
40705
|
+
*/
|
|
40706
|
+
export interface SubscriptionRouteSchedulePlanChangeHTTPRequest {
|
|
40707
|
+
/**
|
|
40708
|
+
*
|
|
40709
|
+
* @type {string}
|
|
40710
|
+
* @memberof SubscriptionRouteSchedulePlanChangeHTTPRequest
|
|
40711
|
+
*/
|
|
40712
|
+
'billing_cycle'?: string;
|
|
40713
|
+
/**
|
|
40714
|
+
*
|
|
40715
|
+
* @type {string}
|
|
40716
|
+
* @memberof SubscriptionRouteSchedulePlanChangeHTTPRequest
|
|
40717
|
+
*/
|
|
40718
|
+
'currency'?: string;
|
|
40719
|
+
/**
|
|
40720
|
+
*
|
|
40721
|
+
* @type {string}
|
|
40722
|
+
* @memberof SubscriptionRouteSchedulePlanChangeHTTPRequest
|
|
40723
|
+
*/
|
|
40724
|
+
'new_plan_identifier'?: string;
|
|
40725
|
+
}
|
|
40540
40726
|
/**
|
|
40541
40727
|
*
|
|
40542
40728
|
* @export
|
|
@@ -41563,6 +41749,14 @@ export declare const AdminNotificationsApiAxiosParamCreator: (configuration?: Co
|
|
|
41563
41749
|
* @throws {RequiredError}
|
|
41564
41750
|
*/
|
|
41565
41751
|
v1AdminNotificationsSendBulkPost: (dataTypesNotificationBatch: DataTypesNotificationBatch, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
41752
|
+
/**
|
|
41753
|
+
* Sends a notification to all active members of the caller\'s organization. The caller must be an org owner or admin. Scope \"all\" includes every member; \"owners_admins\" targets owners and admins only.
|
|
41754
|
+
* @summary Send org-wide notification (Admin)
|
|
41755
|
+
* @param {DataTypesSendOrgNotificationRequest} dataTypesSendOrgNotificationRequest Org notification details
|
|
41756
|
+
* @param {*} [options] Override http request option.
|
|
41757
|
+
* @throws {RequiredError}
|
|
41758
|
+
*/
|
|
41759
|
+
v1AdminNotificationsSendOrgPost: (dataTypesSendOrgNotificationRequest: DataTypesSendOrgNotificationRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
41566
41760
|
/**
|
|
41567
41761
|
* Sends a notification to specified users (requires admin privileges)
|
|
41568
41762
|
* @summary Send notification (Admin)
|
|
@@ -41658,6 +41852,14 @@ export declare const AdminNotificationsApiFp: (configuration?: Configuration) =>
|
|
|
41658
41852
|
* @throws {RequiredError}
|
|
41659
41853
|
*/
|
|
41660
41854
|
v1AdminNotificationsSendBulkPost(dataTypesNotificationBatch: DataTypesNotificationBatch, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesSendBulkNotificationResponse>>;
|
|
41855
|
+
/**
|
|
41856
|
+
* Sends a notification to all active members of the caller\'s organization. The caller must be an org owner or admin. Scope \"all\" includes every member; \"owners_admins\" targets owners and admins only.
|
|
41857
|
+
* @summary Send org-wide notification (Admin)
|
|
41858
|
+
* @param {DataTypesSendOrgNotificationRequest} dataTypesSendOrgNotificationRequest Org notification details
|
|
41859
|
+
* @param {*} [options] Override http request option.
|
|
41860
|
+
* @throws {RequiredError}
|
|
41861
|
+
*/
|
|
41862
|
+
v1AdminNotificationsSendOrgPost(dataTypesSendOrgNotificationRequest: DataTypesSendOrgNotificationRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesSendOrgNotificationResponse>>;
|
|
41661
41863
|
/**
|
|
41662
41864
|
* Sends a notification to specified users (requires admin privileges)
|
|
41663
41865
|
* @summary Send notification (Admin)
|
|
@@ -41753,6 +41955,14 @@ export declare const AdminNotificationsApiFactory: (configuration?: Configuratio
|
|
|
41753
41955
|
* @throws {RequiredError}
|
|
41754
41956
|
*/
|
|
41755
41957
|
v1AdminNotificationsSendBulkPost(dataTypesNotificationBatch: DataTypesNotificationBatch, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesSendBulkNotificationResponse>;
|
|
41958
|
+
/**
|
|
41959
|
+
* Sends a notification to all active members of the caller\'s organization. The caller must be an org owner or admin. Scope \"all\" includes every member; \"owners_admins\" targets owners and admins only.
|
|
41960
|
+
* @summary Send org-wide notification (Admin)
|
|
41961
|
+
* @param {DataTypesSendOrgNotificationRequest} dataTypesSendOrgNotificationRequest Org notification details
|
|
41962
|
+
* @param {*} [options] Override http request option.
|
|
41963
|
+
* @throws {RequiredError}
|
|
41964
|
+
*/
|
|
41965
|
+
v1AdminNotificationsSendOrgPost(dataTypesSendOrgNotificationRequest: DataTypesSendOrgNotificationRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesSendOrgNotificationResponse>;
|
|
41756
41966
|
/**
|
|
41757
41967
|
* Sends a notification to specified users (requires admin privileges)
|
|
41758
41968
|
* @summary Send notification (Admin)
|
|
@@ -41857,6 +42067,15 @@ export declare class AdminNotificationsApi extends BaseAPI {
|
|
|
41857
42067
|
* @memberof AdminNotificationsApi
|
|
41858
42068
|
*/
|
|
41859
42069
|
v1AdminNotificationsSendBulkPost(dataTypesNotificationBatch: DataTypesNotificationBatch, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesSendBulkNotificationResponse, any, {}>>;
|
|
42070
|
+
/**
|
|
42071
|
+
* Sends a notification to all active members of the caller\'s organization. The caller must be an org owner or admin. Scope \"all\" includes every member; \"owners_admins\" targets owners and admins only.
|
|
42072
|
+
* @summary Send org-wide notification (Admin)
|
|
42073
|
+
* @param {DataTypesSendOrgNotificationRequest} dataTypesSendOrgNotificationRequest Org notification details
|
|
42074
|
+
* @param {*} [options] Override http request option.
|
|
42075
|
+
* @throws {RequiredError}
|
|
42076
|
+
* @memberof AdminNotificationsApi
|
|
42077
|
+
*/
|
|
42078
|
+
v1AdminNotificationsSendOrgPost(dataTypesSendOrgNotificationRequest: DataTypesSendOrgNotificationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesSendOrgNotificationResponse, any, {}>>;
|
|
41860
42079
|
/**
|
|
41861
42080
|
* Sends a notification to specified users (requires admin privileges)
|
|
41862
42081
|
* @summary Send notification (Admin)
|
|
@@ -48314,6 +48533,16 @@ export declare const BillingDashboardApiAxiosParamCreator: (configuration?: Conf
|
|
|
48314
48533
|
* @throws {RequiredError}
|
|
48315
48534
|
*/
|
|
48316
48535
|
adminBillingCreditLedgerGet: (orgId?: number, startDate?: string, endDate?: string, page?: number, pageSize?: number, limit?: number, offset?: number, sortBy?: AdminBillingCreditLedgerGetSortByEnum, sortOrder?: AdminBillingCreditLedgerGetSortOrderEnum, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
48536
|
+
/**
|
|
48537
|
+
* Exports credit notes as a CSV file formatted for GSTR-1 filing. Includes credit note number, original invoice reference, GST breakdown, and SAC code.
|
|
48538
|
+
* @summary Export credit notes for GSTR-1
|
|
48539
|
+
* @param {string} [startDate] Start date (YYYY-MM-DD format)
|
|
48540
|
+
* @param {string} [endDate] End date (YYYY-MM-DD format)
|
|
48541
|
+
* @param {string} [fiscalYear] Fiscal year (e.g., 2526)
|
|
48542
|
+
* @param {*} [options] Override http request option.
|
|
48543
|
+
* @throws {RequiredError}
|
|
48544
|
+
*/
|
|
48545
|
+
adminBillingCreditNotesExportGet: (startDate?: string, endDate?: string, fiscalYear?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
48317
48546
|
/**
|
|
48318
48547
|
* Retrieves paginated list of credit purchases with filtering options for the authenticated user\'s organization. Uses page/page_size pagination like analytics APIs.
|
|
48319
48548
|
* @summary Get credit purchases
|
|
@@ -48382,10 +48611,11 @@ export declare const BillingDashboardApiAxiosParamCreator: (configuration?: Conf
|
|
|
48382
48611
|
* @param {number} [limit] Number of results per page (default: 20, max: 100) - alternative to page_size
|
|
48383
48612
|
* @param {AdminBillingInvoicesGetSortByEnum} [sortBy] Field to sort by
|
|
48384
48613
|
* @param {AdminBillingInvoicesGetSortOrderEnum} [sortOrder] Sort direction
|
|
48614
|
+
* @param {AdminBillingInvoicesGetInvoiceTypeEnum} [invoiceType] Filter by invoice type
|
|
48385
48615
|
* @param {*} [options] Override http request option.
|
|
48386
48616
|
* @throws {RequiredError}
|
|
48387
48617
|
*/
|
|
48388
|
-
adminBillingInvoicesGet: (orgId?: number, status?: string, startDate?: string, endDate?: string, search?: string, page?: number, pageSize?: number, limit?: number, sortBy?: AdminBillingInvoicesGetSortByEnum, sortOrder?: AdminBillingInvoicesGetSortOrderEnum, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
48618
|
+
adminBillingInvoicesGet: (orgId?: number, status?: string, startDate?: string, endDate?: string, search?: string, page?: number, pageSize?: number, limit?: number, sortBy?: AdminBillingInvoicesGetSortByEnum, sortOrder?: AdminBillingInvoicesGetSortOrderEnum, invoiceType?: AdminBillingInvoicesGetInvoiceTypeEnum, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
48389
48619
|
/**
|
|
48390
48620
|
* Deletes an invoice (soft delete by setting status to cancelled)
|
|
48391
48621
|
* @summary Delete invoice
|
|
@@ -48427,6 +48657,14 @@ export declare const BillingDashboardApiAxiosParamCreator: (configuration?: Conf
|
|
|
48427
48657
|
* @throws {RequiredError}
|
|
48428
48658
|
*/
|
|
48429
48659
|
adminBillingInvoicesIdPut: (id: string, dataTypesUpdateInvoiceRequest: DataTypesUpdateInvoiceRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
48660
|
+
/**
|
|
48661
|
+
* Voids an issued credit note by setting credit_note_status to \'voided\'. Only credit notes with status \'issued\' can be voided.
|
|
48662
|
+
* @summary Void a credit note
|
|
48663
|
+
* @param {string} id Invoice ID (UUID)
|
|
48664
|
+
* @param {*} [options] Override http request option.
|
|
48665
|
+
* @throws {RequiredError}
|
|
48666
|
+
*/
|
|
48667
|
+
adminBillingInvoicesIdVoidPost: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
48430
48668
|
/**
|
|
48431
48669
|
* Initiates payment for a pending invoice (for subscription orders with failed auto-payments)
|
|
48432
48670
|
* @summary Pay a pending invoice
|
|
@@ -48708,6 +48946,16 @@ export declare const BillingDashboardApiFp: (configuration?: Configuration) => {
|
|
|
48708
48946
|
* @throws {RequiredError}
|
|
48709
48947
|
*/
|
|
48710
48948
|
adminBillingCreditLedgerGet(orgId?: number, startDate?: string, endDate?: string, page?: number, pageSize?: number, limit?: number, offset?: number, sortBy?: AdminBillingCreditLedgerGetSortByEnum, sortOrder?: AdminBillingCreditLedgerGetSortOrderEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesResponse>>;
|
|
48949
|
+
/**
|
|
48950
|
+
* Exports credit notes as a CSV file formatted for GSTR-1 filing. Includes credit note number, original invoice reference, GST breakdown, and SAC code.
|
|
48951
|
+
* @summary Export credit notes for GSTR-1
|
|
48952
|
+
* @param {string} [startDate] Start date (YYYY-MM-DD format)
|
|
48953
|
+
* @param {string} [endDate] End date (YYYY-MM-DD format)
|
|
48954
|
+
* @param {string} [fiscalYear] Fiscal year (e.g., 2526)
|
|
48955
|
+
* @param {*} [options] Override http request option.
|
|
48956
|
+
* @throws {RequiredError}
|
|
48957
|
+
*/
|
|
48958
|
+
adminBillingCreditNotesExportGet(startDate?: string, endDate?: string, fiscalYear?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
|
|
48711
48959
|
/**
|
|
48712
48960
|
* Retrieves paginated list of credit purchases with filtering options for the authenticated user\'s organization. Uses page/page_size pagination like analytics APIs.
|
|
48713
48961
|
* @summary Get credit purchases
|
|
@@ -48776,10 +49024,11 @@ export declare const BillingDashboardApiFp: (configuration?: Configuration) => {
|
|
|
48776
49024
|
* @param {number} [limit] Number of results per page (default: 20, max: 100) - alternative to page_size
|
|
48777
49025
|
* @param {AdminBillingInvoicesGetSortByEnum} [sortBy] Field to sort by
|
|
48778
49026
|
* @param {AdminBillingInvoicesGetSortOrderEnum} [sortOrder] Sort direction
|
|
49027
|
+
* @param {AdminBillingInvoicesGetInvoiceTypeEnum} [invoiceType] Filter by invoice type
|
|
48779
49028
|
* @param {*} [options] Override http request option.
|
|
48780
49029
|
* @throws {RequiredError}
|
|
48781
49030
|
*/
|
|
48782
|
-
adminBillingInvoicesGet(orgId?: number, status?: string, startDate?: string, endDate?: string, search?: string, page?: number, pageSize?: number, limit?: number, sortBy?: AdminBillingInvoicesGetSortByEnum, sortOrder?: AdminBillingInvoicesGetSortOrderEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesResponse>>;
|
|
49031
|
+
adminBillingInvoicesGet(orgId?: number, status?: string, startDate?: string, endDate?: string, search?: string, page?: number, pageSize?: number, limit?: number, sortBy?: AdminBillingInvoicesGetSortByEnum, sortOrder?: AdminBillingInvoicesGetSortOrderEnum, invoiceType?: AdminBillingInvoicesGetInvoiceTypeEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesResponse>>;
|
|
48783
49032
|
/**
|
|
48784
49033
|
* Deletes an invoice (soft delete by setting status to cancelled)
|
|
48785
49034
|
* @summary Delete invoice
|
|
@@ -48821,6 +49070,14 @@ export declare const BillingDashboardApiFp: (configuration?: Configuration) => {
|
|
|
48821
49070
|
* @throws {RequiredError}
|
|
48822
49071
|
*/
|
|
48823
49072
|
adminBillingInvoicesIdPut(id: string, dataTypesUpdateInvoiceRequest: DataTypesUpdateInvoiceRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesResponse>>;
|
|
49073
|
+
/**
|
|
49074
|
+
* Voids an issued credit note by setting credit_note_status to \'voided\'. Only credit notes with status \'issued\' can be voided.
|
|
49075
|
+
* @summary Void a credit note
|
|
49076
|
+
* @param {string} id Invoice ID (UUID)
|
|
49077
|
+
* @param {*} [options] Override http request option.
|
|
49078
|
+
* @throws {RequiredError}
|
|
49079
|
+
*/
|
|
49080
|
+
adminBillingInvoicesIdVoidPost(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesResponse>>;
|
|
48824
49081
|
/**
|
|
48825
49082
|
* Initiates payment for a pending invoice (for subscription orders with failed auto-payments)
|
|
48826
49083
|
* @summary Pay a pending invoice
|
|
@@ -49102,6 +49359,16 @@ export declare const BillingDashboardApiFactory: (configuration?: Configuration,
|
|
|
49102
49359
|
* @throws {RequiredError}
|
|
49103
49360
|
*/
|
|
49104
49361
|
adminBillingCreditLedgerGet(orgId?: number, startDate?: string, endDate?: string, page?: number, pageSize?: number, limit?: number, offset?: number, sortBy?: AdminBillingCreditLedgerGetSortByEnum, sortOrder?: AdminBillingCreditLedgerGetSortOrderEnum, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse>;
|
|
49362
|
+
/**
|
|
49363
|
+
* Exports credit notes as a CSV file formatted for GSTR-1 filing. Includes credit note number, original invoice reference, GST breakdown, and SAC code.
|
|
49364
|
+
* @summary Export credit notes for GSTR-1
|
|
49365
|
+
* @param {string} [startDate] Start date (YYYY-MM-DD format)
|
|
49366
|
+
* @param {string} [endDate] End date (YYYY-MM-DD format)
|
|
49367
|
+
* @param {string} [fiscalYear] Fiscal year (e.g., 2526)
|
|
49368
|
+
* @param {*} [options] Override http request option.
|
|
49369
|
+
* @throws {RequiredError}
|
|
49370
|
+
*/
|
|
49371
|
+
adminBillingCreditNotesExportGet(startDate?: string, endDate?: string, fiscalYear?: string, options?: RawAxiosRequestConfig): AxiosPromise<any>;
|
|
49105
49372
|
/**
|
|
49106
49373
|
* Retrieves paginated list of credit purchases with filtering options for the authenticated user\'s organization. Uses page/page_size pagination like analytics APIs.
|
|
49107
49374
|
* @summary Get credit purchases
|
|
@@ -49170,10 +49437,11 @@ export declare const BillingDashboardApiFactory: (configuration?: Configuration,
|
|
|
49170
49437
|
* @param {number} [limit] Number of results per page (default: 20, max: 100) - alternative to page_size
|
|
49171
49438
|
* @param {AdminBillingInvoicesGetSortByEnum} [sortBy] Field to sort by
|
|
49172
49439
|
* @param {AdminBillingInvoicesGetSortOrderEnum} [sortOrder] Sort direction
|
|
49440
|
+
* @param {AdminBillingInvoicesGetInvoiceTypeEnum} [invoiceType] Filter by invoice type
|
|
49173
49441
|
* @param {*} [options] Override http request option.
|
|
49174
49442
|
* @throws {RequiredError}
|
|
49175
49443
|
*/
|
|
49176
|
-
adminBillingInvoicesGet(orgId?: number, status?: string, startDate?: string, endDate?: string, search?: string, page?: number, pageSize?: number, limit?: number, sortBy?: AdminBillingInvoicesGetSortByEnum, sortOrder?: AdminBillingInvoicesGetSortOrderEnum, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse>;
|
|
49444
|
+
adminBillingInvoicesGet(orgId?: number, status?: string, startDate?: string, endDate?: string, search?: string, page?: number, pageSize?: number, limit?: number, sortBy?: AdminBillingInvoicesGetSortByEnum, sortOrder?: AdminBillingInvoicesGetSortOrderEnum, invoiceType?: AdminBillingInvoicesGetInvoiceTypeEnum, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse>;
|
|
49177
49445
|
/**
|
|
49178
49446
|
* Deletes an invoice (soft delete by setting status to cancelled)
|
|
49179
49447
|
* @summary Delete invoice
|
|
@@ -49215,6 +49483,14 @@ export declare const BillingDashboardApiFactory: (configuration?: Configuration,
|
|
|
49215
49483
|
* @throws {RequiredError}
|
|
49216
49484
|
*/
|
|
49217
49485
|
adminBillingInvoicesIdPut(id: string, dataTypesUpdateInvoiceRequest: DataTypesUpdateInvoiceRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse>;
|
|
49486
|
+
/**
|
|
49487
|
+
* Voids an issued credit note by setting credit_note_status to \'voided\'. Only credit notes with status \'issued\' can be voided.
|
|
49488
|
+
* @summary Void a credit note
|
|
49489
|
+
* @param {string} id Invoice ID (UUID)
|
|
49490
|
+
* @param {*} [options] Override http request option.
|
|
49491
|
+
* @throws {RequiredError}
|
|
49492
|
+
*/
|
|
49493
|
+
adminBillingInvoicesIdVoidPost(id: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse>;
|
|
49218
49494
|
/**
|
|
49219
49495
|
* Initiates payment for a pending invoice (for subscription orders with failed auto-payments)
|
|
49220
49496
|
* @summary Pay a pending invoice
|
|
@@ -49506,6 +49782,17 @@ export declare class BillingDashboardApi extends BaseAPI {
|
|
|
49506
49782
|
* @memberof BillingDashboardApi
|
|
49507
49783
|
*/
|
|
49508
49784
|
adminBillingCreditLedgerGet(orgId?: number, startDate?: string, endDate?: string, page?: number, pageSize?: number, limit?: number, offset?: number, sortBy?: AdminBillingCreditLedgerGetSortByEnum, sortOrder?: AdminBillingCreditLedgerGetSortOrderEnum, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any, {}>>;
|
|
49785
|
+
/**
|
|
49786
|
+
* Exports credit notes as a CSV file formatted for GSTR-1 filing. Includes credit note number, original invoice reference, GST breakdown, and SAC code.
|
|
49787
|
+
* @summary Export credit notes for GSTR-1
|
|
49788
|
+
* @param {string} [startDate] Start date (YYYY-MM-DD format)
|
|
49789
|
+
* @param {string} [endDate] End date (YYYY-MM-DD format)
|
|
49790
|
+
* @param {string} [fiscalYear] Fiscal year (e.g., 2526)
|
|
49791
|
+
* @param {*} [options] Override http request option.
|
|
49792
|
+
* @throws {RequiredError}
|
|
49793
|
+
* @memberof BillingDashboardApi
|
|
49794
|
+
*/
|
|
49795
|
+
adminBillingCreditNotesExportGet(startDate?: string, endDate?: string, fiscalYear?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<any, any, {}>>;
|
|
49509
49796
|
/**
|
|
49510
49797
|
* Retrieves paginated list of credit purchases with filtering options for the authenticated user\'s organization. Uses page/page_size pagination like analytics APIs.
|
|
49511
49798
|
* @summary Get credit purchases
|
|
@@ -49579,11 +49866,12 @@ export declare class BillingDashboardApi extends BaseAPI {
|
|
|
49579
49866
|
* @param {number} [limit] Number of results per page (default: 20, max: 100) - alternative to page_size
|
|
49580
49867
|
* @param {AdminBillingInvoicesGetSortByEnum} [sortBy] Field to sort by
|
|
49581
49868
|
* @param {AdminBillingInvoicesGetSortOrderEnum} [sortOrder] Sort direction
|
|
49869
|
+
* @param {AdminBillingInvoicesGetInvoiceTypeEnum} [invoiceType] Filter by invoice type
|
|
49582
49870
|
* @param {*} [options] Override http request option.
|
|
49583
49871
|
* @throws {RequiredError}
|
|
49584
49872
|
* @memberof BillingDashboardApi
|
|
49585
49873
|
*/
|
|
49586
|
-
adminBillingInvoicesGet(orgId?: number, status?: string, startDate?: string, endDate?: string, search?: string, page?: number, pageSize?: number, limit?: number, sortBy?: AdminBillingInvoicesGetSortByEnum, sortOrder?: AdminBillingInvoicesGetSortOrderEnum, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any, {}>>;
|
|
49874
|
+
adminBillingInvoicesGet(orgId?: number, status?: string, startDate?: string, endDate?: string, search?: string, page?: number, pageSize?: number, limit?: number, sortBy?: AdminBillingInvoicesGetSortByEnum, sortOrder?: AdminBillingInvoicesGetSortOrderEnum, invoiceType?: AdminBillingInvoicesGetInvoiceTypeEnum, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any, {}>>;
|
|
49587
49875
|
/**
|
|
49588
49876
|
* Deletes an invoice (soft delete by setting status to cancelled)
|
|
49589
49877
|
* @summary Delete invoice
|
|
@@ -49630,6 +49918,15 @@ export declare class BillingDashboardApi extends BaseAPI {
|
|
|
49630
49918
|
* @memberof BillingDashboardApi
|
|
49631
49919
|
*/
|
|
49632
49920
|
adminBillingInvoicesIdPut(id: string, dataTypesUpdateInvoiceRequest: DataTypesUpdateInvoiceRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any, {}>>;
|
|
49921
|
+
/**
|
|
49922
|
+
* Voids an issued credit note by setting credit_note_status to \'voided\'. Only credit notes with status \'issued\' can be voided.
|
|
49923
|
+
* @summary Void a credit note
|
|
49924
|
+
* @param {string} id Invoice ID (UUID)
|
|
49925
|
+
* @param {*} [options] Override http request option.
|
|
49926
|
+
* @throws {RequiredError}
|
|
49927
|
+
* @memberof BillingDashboardApi
|
|
49928
|
+
*/
|
|
49929
|
+
adminBillingInvoicesIdVoidPost(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any, {}>>;
|
|
49633
49930
|
/**
|
|
49634
49931
|
* Initiates payment for a pending invoice (for subscription orders with failed auto-payments)
|
|
49635
49932
|
* @summary Pay a pending invoice
|
|
@@ -49930,6 +50227,14 @@ export declare const AdminBillingInvoicesGetSortOrderEnum: {
|
|
|
49930
50227
|
readonly Desc2: "DESC";
|
|
49931
50228
|
};
|
|
49932
50229
|
export type AdminBillingInvoicesGetSortOrderEnum = typeof AdminBillingInvoicesGetSortOrderEnum[keyof typeof AdminBillingInvoicesGetSortOrderEnum];
|
|
50230
|
+
/**
|
|
50231
|
+
* @export
|
|
50232
|
+
*/
|
|
50233
|
+
export declare const AdminBillingInvoicesGetInvoiceTypeEnum: {
|
|
50234
|
+
readonly TaxInvoice: "tax_invoice";
|
|
50235
|
+
readonly CreditNote: "credit_note";
|
|
50236
|
+
};
|
|
50237
|
+
export type AdminBillingInvoicesGetInvoiceTypeEnum = typeof AdminBillingInvoicesGetInvoiceTypeEnum[keyof typeof AdminBillingInvoicesGetInvoiceTypeEnum];
|
|
49933
50238
|
/**
|
|
49934
50239
|
* @export
|
|
49935
50240
|
*/
|
|
@@ -66914,6 +67219,14 @@ export declare const SubscriptionsApiAxiosParamCreator: (configuration?: Configu
|
|
|
66914
67219
|
* @throws {RequiredError}
|
|
66915
67220
|
*/
|
|
66916
67221
|
adminSubscriptionsCancelProcessPost: (subscriptionRouteCancelProcessRequest: SubscriptionRouteCancelProcessRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
67222
|
+
/**
|
|
67223
|
+
* Creates a one-time Razorpay order for the net charge amount (new_plan_price - prorated_refund). Frontend opens Razorpay checkout. On payment.captured, the existing subscription is patched to the new plan.
|
|
67224
|
+
* @summary Create an immediate plan change order
|
|
67225
|
+
* @param {SubscriptionRouteImmediatePlanChangeOrderHTTPRequest} subscriptionRouteImmediatePlanChangeOrderHTTPRequest Immediate plan change order request
|
|
67226
|
+
* @param {*} [options] Override http request option.
|
|
67227
|
+
* @throws {RequiredError}
|
|
67228
|
+
*/
|
|
67229
|
+
adminSubscriptionsPlanChangeImmediateOrderPost: (subscriptionRouteImmediatePlanChangeOrderHTTPRequest: SubscriptionRouteImmediatePlanChangeOrderHTTPRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
66917
67230
|
/**
|
|
66918
67231
|
* Shows a read-only preview of what happens when changing plans: refund for current plan, credits removed/added, new plan cost. Org ID is automatically extracted from JWT session.
|
|
66919
67232
|
* @summary Preview plan change details
|
|
@@ -66922,6 +67235,28 @@ export declare const SubscriptionsApiAxiosParamCreator: (configuration?: Configu
|
|
|
66922
67235
|
* @throws {RequiredError}
|
|
66923
67236
|
*/
|
|
66924
67237
|
adminSubscriptionsPlanChangePreviewPost: (subscriptionRoutePlanChangePreviewHTTPRequest: SubscriptionRoutePlanChangePreviewHTTPRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
67238
|
+
/**
|
|
67239
|
+
* Cancels a pending scheduled plan change, reverting the Razorpay subscription to the original plan.
|
|
67240
|
+
* @summary Cancel a scheduled plan change
|
|
67241
|
+
* @param {*} [options] Override http request option.
|
|
67242
|
+
* @throws {RequiredError}
|
|
67243
|
+
*/
|
|
67244
|
+
adminSubscriptionsPlanChangeScheduleDelete: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
67245
|
+
/**
|
|
67246
|
+
* Returns the pending scheduled plan change for the organization, or null if none.
|
|
67247
|
+
* @summary Get pending scheduled plan change
|
|
67248
|
+
* @param {*} [options] Override http request option.
|
|
67249
|
+
* @throws {RequiredError}
|
|
67250
|
+
*/
|
|
67251
|
+
adminSubscriptionsPlanChangeScheduleGet: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
67252
|
+
/**
|
|
67253
|
+
* Creates a one-time Razorpay order for the net charge amount. Payment is collected now; plan activation is deferred to cycle end. Returns 409 if a pending scheduled change already exists. For free switches (proration covers full cost), schedules directly without payment.
|
|
67254
|
+
* @summary Schedule a plan change at end of billing cycle
|
|
67255
|
+
* @param {SubscriptionRouteSchedulePlanChangeHTTPRequest} subscriptionRouteSchedulePlanChangeHTTPRequest Schedule plan change request
|
|
67256
|
+
* @param {*} [options] Override http request option.
|
|
67257
|
+
* @throws {RequiredError}
|
|
67258
|
+
*/
|
|
67259
|
+
adminSubscriptionsPlanChangeSchedulePost: (subscriptionRouteSchedulePlanChangeHTTPRequest: SubscriptionRouteSchedulePlanChangeHTTPRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
66925
67260
|
/**
|
|
66926
67261
|
* Updates Subscription information by ID.
|
|
66927
67262
|
* @summary Update an existing Subscription
|
|
@@ -66985,6 +67320,14 @@ export declare const SubscriptionsApiFp: (configuration?: Configuration) => {
|
|
|
66985
67320
|
* @throws {RequiredError}
|
|
66986
67321
|
*/
|
|
66987
67322
|
adminSubscriptionsCancelProcessPost(subscriptionRouteCancelProcessRequest: SubscriptionRouteCancelProcessRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesResponse>>;
|
|
67323
|
+
/**
|
|
67324
|
+
* Creates a one-time Razorpay order for the net charge amount (new_plan_price - prorated_refund). Frontend opens Razorpay checkout. On payment.captured, the existing subscription is patched to the new plan.
|
|
67325
|
+
* @summary Create an immediate plan change order
|
|
67326
|
+
* @param {SubscriptionRouteImmediatePlanChangeOrderHTTPRequest} subscriptionRouteImmediatePlanChangeOrderHTTPRequest Immediate plan change order request
|
|
67327
|
+
* @param {*} [options] Override http request option.
|
|
67328
|
+
* @throws {RequiredError}
|
|
67329
|
+
*/
|
|
67330
|
+
adminSubscriptionsPlanChangeImmediateOrderPost(subscriptionRouteImmediatePlanChangeOrderHTTPRequest: SubscriptionRouteImmediatePlanChangeOrderHTTPRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesResponse>>;
|
|
66988
67331
|
/**
|
|
66989
67332
|
* Shows a read-only preview of what happens when changing plans: refund for current plan, credits removed/added, new plan cost. Org ID is automatically extracted from JWT session.
|
|
66990
67333
|
* @summary Preview plan change details
|
|
@@ -66993,6 +67336,28 @@ export declare const SubscriptionsApiFp: (configuration?: Configuration) => {
|
|
|
66993
67336
|
* @throws {RequiredError}
|
|
66994
67337
|
*/
|
|
66995
67338
|
adminSubscriptionsPlanChangePreviewPost(subscriptionRoutePlanChangePreviewHTTPRequest: SubscriptionRoutePlanChangePreviewHTTPRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesResponse>>;
|
|
67339
|
+
/**
|
|
67340
|
+
* Cancels a pending scheduled plan change, reverting the Razorpay subscription to the original plan.
|
|
67341
|
+
* @summary Cancel a scheduled plan change
|
|
67342
|
+
* @param {*} [options] Override http request option.
|
|
67343
|
+
* @throws {RequiredError}
|
|
67344
|
+
*/
|
|
67345
|
+
adminSubscriptionsPlanChangeScheduleDelete(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesResponse>>;
|
|
67346
|
+
/**
|
|
67347
|
+
* Returns the pending scheduled plan change for the organization, or null if none.
|
|
67348
|
+
* @summary Get pending scheduled plan change
|
|
67349
|
+
* @param {*} [options] Override http request option.
|
|
67350
|
+
* @throws {RequiredError}
|
|
67351
|
+
*/
|
|
67352
|
+
adminSubscriptionsPlanChangeScheduleGet(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesResponse>>;
|
|
67353
|
+
/**
|
|
67354
|
+
* Creates a one-time Razorpay order for the net charge amount. Payment is collected now; plan activation is deferred to cycle end. Returns 409 if a pending scheduled change already exists. For free switches (proration covers full cost), schedules directly without payment.
|
|
67355
|
+
* @summary Schedule a plan change at end of billing cycle
|
|
67356
|
+
* @param {SubscriptionRouteSchedulePlanChangeHTTPRequest} subscriptionRouteSchedulePlanChangeHTTPRequest Schedule plan change request
|
|
67357
|
+
* @param {*} [options] Override http request option.
|
|
67358
|
+
* @throws {RequiredError}
|
|
67359
|
+
*/
|
|
67360
|
+
adminSubscriptionsPlanChangeSchedulePost(subscriptionRouteSchedulePlanChangeHTTPRequest: SubscriptionRouteSchedulePlanChangeHTTPRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesResponse>>;
|
|
66996
67361
|
/**
|
|
66997
67362
|
* Updates Subscription information by ID.
|
|
66998
67363
|
* @summary Update an existing Subscription
|
|
@@ -67056,6 +67421,14 @@ export declare const SubscriptionsApiFactory: (configuration?: Configuration, ba
|
|
|
67056
67421
|
* @throws {RequiredError}
|
|
67057
67422
|
*/
|
|
67058
67423
|
adminSubscriptionsCancelProcessPost(subscriptionRouteCancelProcessRequest: SubscriptionRouteCancelProcessRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse>;
|
|
67424
|
+
/**
|
|
67425
|
+
* Creates a one-time Razorpay order for the net charge amount (new_plan_price - prorated_refund). Frontend opens Razorpay checkout. On payment.captured, the existing subscription is patched to the new plan.
|
|
67426
|
+
* @summary Create an immediate plan change order
|
|
67427
|
+
* @param {SubscriptionRouteImmediatePlanChangeOrderHTTPRequest} subscriptionRouteImmediatePlanChangeOrderHTTPRequest Immediate plan change order request
|
|
67428
|
+
* @param {*} [options] Override http request option.
|
|
67429
|
+
* @throws {RequiredError}
|
|
67430
|
+
*/
|
|
67431
|
+
adminSubscriptionsPlanChangeImmediateOrderPost(subscriptionRouteImmediatePlanChangeOrderHTTPRequest: SubscriptionRouteImmediatePlanChangeOrderHTTPRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse>;
|
|
67059
67432
|
/**
|
|
67060
67433
|
* Shows a read-only preview of what happens when changing plans: refund for current plan, credits removed/added, new plan cost. Org ID is automatically extracted from JWT session.
|
|
67061
67434
|
* @summary Preview plan change details
|
|
@@ -67064,6 +67437,28 @@ export declare const SubscriptionsApiFactory: (configuration?: Configuration, ba
|
|
|
67064
67437
|
* @throws {RequiredError}
|
|
67065
67438
|
*/
|
|
67066
67439
|
adminSubscriptionsPlanChangePreviewPost(subscriptionRoutePlanChangePreviewHTTPRequest: SubscriptionRoutePlanChangePreviewHTTPRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse>;
|
|
67440
|
+
/**
|
|
67441
|
+
* Cancels a pending scheduled plan change, reverting the Razorpay subscription to the original plan.
|
|
67442
|
+
* @summary Cancel a scheduled plan change
|
|
67443
|
+
* @param {*} [options] Override http request option.
|
|
67444
|
+
* @throws {RequiredError}
|
|
67445
|
+
*/
|
|
67446
|
+
adminSubscriptionsPlanChangeScheduleDelete(options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse>;
|
|
67447
|
+
/**
|
|
67448
|
+
* Returns the pending scheduled plan change for the organization, or null if none.
|
|
67449
|
+
* @summary Get pending scheduled plan change
|
|
67450
|
+
* @param {*} [options] Override http request option.
|
|
67451
|
+
* @throws {RequiredError}
|
|
67452
|
+
*/
|
|
67453
|
+
adminSubscriptionsPlanChangeScheduleGet(options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse>;
|
|
67454
|
+
/**
|
|
67455
|
+
* Creates a one-time Razorpay order for the net charge amount. Payment is collected now; plan activation is deferred to cycle end. Returns 409 if a pending scheduled change already exists. For free switches (proration covers full cost), schedules directly without payment.
|
|
67456
|
+
* @summary Schedule a plan change at end of billing cycle
|
|
67457
|
+
* @param {SubscriptionRouteSchedulePlanChangeHTTPRequest} subscriptionRouteSchedulePlanChangeHTTPRequest Schedule plan change request
|
|
67458
|
+
* @param {*} [options] Override http request option.
|
|
67459
|
+
* @throws {RequiredError}
|
|
67460
|
+
*/
|
|
67461
|
+
adminSubscriptionsPlanChangeSchedulePost(subscriptionRouteSchedulePlanChangeHTTPRequest: SubscriptionRouteSchedulePlanChangeHTTPRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse>;
|
|
67067
67462
|
/**
|
|
67068
67463
|
* Updates Subscription information by ID.
|
|
67069
67464
|
* @summary Update an existing Subscription
|
|
@@ -67131,6 +67526,15 @@ export declare class SubscriptionsApi extends BaseAPI {
|
|
|
67131
67526
|
* @memberof SubscriptionsApi
|
|
67132
67527
|
*/
|
|
67133
67528
|
adminSubscriptionsCancelProcessPost(subscriptionRouteCancelProcessRequest: SubscriptionRouteCancelProcessRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any, {}>>;
|
|
67529
|
+
/**
|
|
67530
|
+
* Creates a one-time Razorpay order for the net charge amount (new_plan_price - prorated_refund). Frontend opens Razorpay checkout. On payment.captured, the existing subscription is patched to the new plan.
|
|
67531
|
+
* @summary Create an immediate plan change order
|
|
67532
|
+
* @param {SubscriptionRouteImmediatePlanChangeOrderHTTPRequest} subscriptionRouteImmediatePlanChangeOrderHTTPRequest Immediate plan change order request
|
|
67533
|
+
* @param {*} [options] Override http request option.
|
|
67534
|
+
* @throws {RequiredError}
|
|
67535
|
+
* @memberof SubscriptionsApi
|
|
67536
|
+
*/
|
|
67537
|
+
adminSubscriptionsPlanChangeImmediateOrderPost(subscriptionRouteImmediatePlanChangeOrderHTTPRequest: SubscriptionRouteImmediatePlanChangeOrderHTTPRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any, {}>>;
|
|
67134
67538
|
/**
|
|
67135
67539
|
* Shows a read-only preview of what happens when changing plans: refund for current plan, credits removed/added, new plan cost. Org ID is automatically extracted from JWT session.
|
|
67136
67540
|
* @summary Preview plan change details
|
|
@@ -67140,6 +67544,31 @@ export declare class SubscriptionsApi extends BaseAPI {
|
|
|
67140
67544
|
* @memberof SubscriptionsApi
|
|
67141
67545
|
*/
|
|
67142
67546
|
adminSubscriptionsPlanChangePreviewPost(subscriptionRoutePlanChangePreviewHTTPRequest: SubscriptionRoutePlanChangePreviewHTTPRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any, {}>>;
|
|
67547
|
+
/**
|
|
67548
|
+
* Cancels a pending scheduled plan change, reverting the Razorpay subscription to the original plan.
|
|
67549
|
+
* @summary Cancel a scheduled plan change
|
|
67550
|
+
* @param {*} [options] Override http request option.
|
|
67551
|
+
* @throws {RequiredError}
|
|
67552
|
+
* @memberof SubscriptionsApi
|
|
67553
|
+
*/
|
|
67554
|
+
adminSubscriptionsPlanChangeScheduleDelete(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any, {}>>;
|
|
67555
|
+
/**
|
|
67556
|
+
* Returns the pending scheduled plan change for the organization, or null if none.
|
|
67557
|
+
* @summary Get pending scheduled plan change
|
|
67558
|
+
* @param {*} [options] Override http request option.
|
|
67559
|
+
* @throws {RequiredError}
|
|
67560
|
+
* @memberof SubscriptionsApi
|
|
67561
|
+
*/
|
|
67562
|
+
adminSubscriptionsPlanChangeScheduleGet(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any, {}>>;
|
|
67563
|
+
/**
|
|
67564
|
+
* Creates a one-time Razorpay order for the net charge amount. Payment is collected now; plan activation is deferred to cycle end. Returns 409 if a pending scheduled change already exists. For free switches (proration covers full cost), schedules directly without payment.
|
|
67565
|
+
* @summary Schedule a plan change at end of billing cycle
|
|
67566
|
+
* @param {SubscriptionRouteSchedulePlanChangeHTTPRequest} subscriptionRouteSchedulePlanChangeHTTPRequest Schedule plan change request
|
|
67567
|
+
* @param {*} [options] Override http request option.
|
|
67568
|
+
* @throws {RequiredError}
|
|
67569
|
+
* @memberof SubscriptionsApi
|
|
67570
|
+
*/
|
|
67571
|
+
adminSubscriptionsPlanChangeSchedulePost(subscriptionRouteSchedulePlanChangeHTTPRequest: SubscriptionRouteSchedulePlanChangeHTTPRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any, {}>>;
|
|
67143
67572
|
/**
|
|
67144
67573
|
* Updates Subscription information by ID.
|
|
67145
67574
|
* @summary Update an existing Subscription
|