From 1a253813b716fdb9143b87c8eef38e87481dccdb Mon Sep 17 00:00:00 2001 From: Tornike Nanobashvili Date: Tue, 9 Apr 2024 13:46:06 +0400 Subject: [PATCH] Update subscription/one-time-sale prefix examples (#1824) * Update subscription/one-time-sale prefix examples * Retrigger pipes --- .../code_samples/JavaScript/subscription-cancellations/post.js | 2 +- .../JavaScript/subscription-cancellations@{id}/put.js | 2 +- .../code_samples/JavaScript/subscription-reactivations/post.js | 2 +- .../components/requestBodies/Webhooks/RenewalInvoiceIssued.yaml | 2 +- .../Webhooks/SubscriptionAndSubscriptionPause.yaml | 2 +- .../components/requestBodies/Webhooks/SubscriptionWebhook.yaml | 2 +- .../components/requestBodies/Webhooks/UsageLimitWebhook.yaml | 2 +- openapi/components/schemas/Invoice.yaml | 2 +- openapi/components/schemas/InvoiceItem.yaml | 2 +- openapi/components/schemas/OneTimeSale.yaml | 2 +- openapi/components/schemas/StorefrontInvoice.yaml | 2 +- openapi/components/schemas/StorefrontOneTimeSale.yaml | 2 +- openapi/components/schemas/StorefrontSubscription.yaml | 2 +- openapi/components/schemas/Subscription.yaml | 2 +- openapi/components/schemas/SubscriptionPause.yaml | 2 +- openapi/components/schemas/UpcomingInvoice.yaml | 2 +- openapi/components/schemas/UpcomingInvoiceItem.yaml | 2 +- openapi/components/schemas/Usage.yaml | 2 +- 18 files changed, 18 insertions(+), 18 deletions(-) diff --git a/openapi/code_samples/JavaScript/subscription-cancellations/post.js b/openapi/code_samples/JavaScript/subscription-cancellations/post.js index a6b4aeda7a..5af944eeca 100644 --- a/openapi/code_samples/JavaScript/subscription-cancellations/post.js +++ b/openapi/code_samples/JavaScript/subscription-cancellations/post.js @@ -1,5 +1,5 @@ const data = { - subscriptionId: 'ord_01GYJPRKHBD6ZYHH897QCJMBS4', + subscriptionId: 'sub_01HRF27SATGE4Z6PBJE6PD8328', churnTime: '2020-06-10T13:55:51Z', } diff --git a/openapi/code_samples/JavaScript/subscription-cancellations@{id}/put.js b/openapi/code_samples/JavaScript/subscription-cancellations@{id}/put.js index a6b4aeda7a..5af944eeca 100644 --- a/openapi/code_samples/JavaScript/subscription-cancellations@{id}/put.js +++ b/openapi/code_samples/JavaScript/subscription-cancellations@{id}/put.js @@ -1,5 +1,5 @@ const data = { - subscriptionId: 'ord_01GYJPRKHBD6ZYHH897QCJMBS4', + subscriptionId: 'sub_01HRF27SATGE4Z6PBJE6PD8328', churnTime: '2020-06-10T13:55:51Z', } diff --git a/openapi/code_samples/JavaScript/subscription-reactivations/post.js b/openapi/code_samples/JavaScript/subscription-reactivations/post.js index b33b5a68ce..e729a4a300 100644 --- a/openapi/code_samples/JavaScript/subscription-reactivations/post.js +++ b/openapi/code_samples/JavaScript/subscription-reactivations/post.js @@ -1,5 +1,5 @@ const data = { - subscriptionId: 'ord_01GYJPRKHBD6ZYHH897QCJMBS4', + subscriptionId: 'sub_01HRF27SATGE4Z6PBJE6PD8328', description: 'reactivation-reason', effectiveTime: '2020-06-10T13:55:51Z', renewalTime: '2020-07-10T13:55:51Z' diff --git a/openapi/components/requestBodies/Webhooks/RenewalInvoiceIssued.yaml b/openapi/components/requestBodies/Webhooks/RenewalInvoiceIssued.yaml index f9ecaff99d..4fe51ab177 100644 --- a/openapi/components/requestBodies/Webhooks/RenewalInvoiceIssued.yaml +++ b/openapi/components/requestBodies/Webhooks/RenewalInvoiceIssued.yaml @@ -5,7 +5,7 @@ content: subscriptionId: type: string description: ID of the order. - example: ord_01GYJPRKHBD6ZYHH897QCJMBS4 + example: sub_01HRF27SATGE4Z6PBJE6PD8328 invoiceId: type: string description: ID of the invoice. diff --git a/openapi/components/requestBodies/Webhooks/SubscriptionAndSubscriptionPause.yaml b/openapi/components/requestBodies/Webhooks/SubscriptionAndSubscriptionPause.yaml index 29c41f4f8e..8d484be97a 100644 --- a/openapi/components/requestBodies/Webhooks/SubscriptionAndSubscriptionPause.yaml +++ b/openapi/components/requestBodies/Webhooks/SubscriptionAndSubscriptionPause.yaml @@ -5,7 +5,7 @@ content: subscriptionId: type: string description: ID of the order. - example: ord_01GYJPRKHBD6ZYHH897QCJMBS4 + example: sub_01HRF27SATGE4Z6PBJE6PD8328 subscriptionPauseId: type: string description: ID of the subscription pause. diff --git a/openapi/components/requestBodies/Webhooks/SubscriptionWebhook.yaml b/openapi/components/requestBodies/Webhooks/SubscriptionWebhook.yaml index 12fd072709..ee5aedbd83 100644 --- a/openapi/components/requestBodies/Webhooks/SubscriptionWebhook.yaml +++ b/openapi/components/requestBodies/Webhooks/SubscriptionWebhook.yaml @@ -5,7 +5,7 @@ content: subscriptionId: type: string description: ID of the order. - example: ord_01GYJPRKHBD6ZYHH897QCJMBS4 + example: sub_01HRF27SATGE4Z6PBJE6PD8328 eventType: type: string description: Type of webhook event. diff --git a/openapi/components/requestBodies/Webhooks/UsageLimitWebhook.yaml b/openapi/components/requestBodies/Webhooks/UsageLimitWebhook.yaml index fe45ce9f7e..6611834b2a 100644 --- a/openapi/components/requestBodies/Webhooks/UsageLimitWebhook.yaml +++ b/openapi/components/requestBodies/Webhooks/UsageLimitWebhook.yaml @@ -5,7 +5,7 @@ content: subscriptionId: type: string description: ID of the order. - example: ord_01GYJPRKHBD6ZYHH897QCJMBS4 + example: sub_01HRF27SATGE4Z6PBJE6PD8328 subscriptionItemId: type: string description: ID of the order item. diff --git a/openapi/components/schemas/Invoice.yaml b/openapi/components/schemas/Invoice.yaml index ae3e8a6b7f..e4f62d922f 100644 --- a/openapi/components/schemas/Invoice.yaml +++ b/openapi/components/schemas/Invoice.yaml @@ -30,7 +30,7 @@ properties: This field is `null` if there are no related subscription orders. readOnly: true maxLength: 50 - example: ord_01GYJPRKHBD6ZYHH897QCJMBS4 + example: sub_01HRF27SATGE4Z6PBJE6PD8328 quoteId: type: - "string" diff --git a/openapi/components/schemas/InvoiceItem.yaml b/openapi/components/schemas/InvoiceItem.yaml index 9ca5909fa4..82dfa17883 100644 --- a/openapi/components/schemas/InvoiceItem.yaml +++ b/openapi/components/schemas/InvoiceItem.yaml @@ -54,7 +54,7 @@ properties: description: ID of the order. maxLength: 50 readOnly: true - example: ord_01GYJPRKHBD6ZYHH897QCJMBS4 + example: sub_01HRF27SATGE4Z6PBJE6PD8328 discountAmount: description: Discount amount applied to the invoice item. type: number diff --git a/openapi/components/schemas/OneTimeSale.yaml b/openapi/components/schemas/OneTimeSale.yaml index 457237d0cd..b3f5f0207a 100644 --- a/openapi/components/schemas/OneTimeSale.yaml +++ b/openapi/components/schemas/OneTimeSale.yaml @@ -10,7 +10,7 @@ properties: description: ID of the order. readOnly: true maxLength: 50 - example: ord_01GYJPRKHBD6ZYHH897QCJMBS4 + example: pur_01HRF26JK5Y6TEZ9MR014HW27Z orderId: type: string description: ID of the order (experimental). diff --git a/openapi/components/schemas/StorefrontInvoice.yaml b/openapi/components/schemas/StorefrontInvoice.yaml index 1011c63bee..3924449746 100644 --- a/openapi/components/schemas/StorefrontInvoice.yaml +++ b/openapi/components/schemas/StorefrontInvoice.yaml @@ -26,7 +26,7 @@ properties: This field is `null` if there are no related subscription orders. readOnly: true maxLength: 50 - example: ord_01GYJPRKHBD6ZYHH897QCJMBS4 + example: sub_01HRF27SATGE4Z6PBJE6PD8328 currency: x-sortable: true x-basic: true diff --git a/openapi/components/schemas/StorefrontOneTimeSale.yaml b/openapi/components/schemas/StorefrontOneTimeSale.yaml index 939dd498e6..38f0c6c833 100644 --- a/openapi/components/schemas/StorefrontOneTimeSale.yaml +++ b/openapi/components/schemas/StorefrontOneTimeSale.yaml @@ -5,7 +5,7 @@ properties: description: ID of the order. readOnly: true maxLength: 50 - example: ord_01GYJPRKHBD6ZYHH897QCJMBS4 + example: pur_01HRF26JK5Y6TEZ9MR014HW27Z orderType: description: |- Specifies the type of order. diff --git a/openapi/components/schemas/StorefrontSubscription.yaml b/openapi/components/schemas/StorefrontSubscription.yaml index f41df9257c..1196b2dc55 100644 --- a/openapi/components/schemas/StorefrontSubscription.yaml +++ b/openapi/components/schemas/StorefrontSubscription.yaml @@ -5,7 +5,7 @@ properties: description: ID of the order. readOnly: true maxLength: 50 - example: ord_01GYJPRKHBD6ZYHH897QCJMBS4 + example: sub_01HRF27SATGE4Z6PBJE6PD8328 orderType: description: |- Specifies the type of order. diff --git a/openapi/components/schemas/Subscription.yaml b/openapi/components/schemas/Subscription.yaml index df058269e2..3d004c886d 100644 --- a/openapi/components/schemas/Subscription.yaml +++ b/openapi/components/schemas/Subscription.yaml @@ -10,7 +10,7 @@ properties: description: ID of the order. readOnly: true maxLength: 50 - example: ord_01GYJPRKHBD6ZYHH897QCJMBS4 + example: sub_01HRF27SATGE4Z6PBJE6PD8328 orderId: type: string description: ID of the order (experimental). diff --git a/openapi/components/schemas/SubscriptionPause.yaml b/openapi/components/schemas/SubscriptionPause.yaml index fd61358ae7..cec39bfd4a 100644 --- a/openapi/components/schemas/SubscriptionPause.yaml +++ b/openapi/components/schemas/SubscriptionPause.yaml @@ -13,7 +13,7 @@ properties: type: string description: ID of the paused subscription. maxLength: 50 - example: ord_01GYJPRKHBD6ZYHH897QCJMBS4 + example: sub_01HRF27SATGE4Z6PBJE6PD8328 status: description: Status of the subscription pause. type: string diff --git a/openapi/components/schemas/UpcomingInvoice.yaml b/openapi/components/schemas/UpcomingInvoice.yaml index 3f7982b3c7..7691f24a13 100644 --- a/openapi/components/schemas/UpcomingInvoice.yaml +++ b/openapi/components/schemas/UpcomingInvoice.yaml @@ -14,7 +14,7 @@ properties: type: string readOnly: true maxLength: 50 - example: ord_01GYJPRKHBD6ZYHH897QCJMBS4 + example: sub_01HRF27SATGE4Z6PBJE6PD8328 currency: x-sortable: true x-basic: true diff --git a/openapi/components/schemas/UpcomingInvoiceItem.yaml b/openapi/components/schemas/UpcomingInvoiceItem.yaml index df7faf8038..c8491337d6 100644 --- a/openapi/components/schemas/UpcomingInvoiceItem.yaml +++ b/openapi/components/schemas/UpcomingInvoiceItem.yaml @@ -42,7 +42,7 @@ properties: type: string description: ID of the order. maxLength: 50 - example: ord_01GYJPRKHBD6ZYHH897QCJMBS4 + example: sub_01HRF27SATGE4Z6PBJE6PD8328 periodStartTime: description: Date and time when the billing period starts. type: string diff --git a/openapi/components/schemas/Usage.yaml b/openapi/components/schemas/Usage.yaml index 32ca500b73..2f787e05ee 100644 --- a/openapi/components/schemas/Usage.yaml +++ b/openapi/components/schemas/Usage.yaml @@ -14,7 +14,7 @@ properties: type: string description: ID of the subscription for which a usage is reported. maxLength: 50 - example: ord_01GYJPRKHBD6ZYHH897QCJMBS4 + example: sub_01HRF27SATGE4Z6PBJE6PD8328 planId: type: string description: ID of the plan for which a usage is reported.