{ "uuid": "9cf29c9d-86b5-476b-bf69-7eb34cae539a", "lastMigration": 29, "name": "Payments Reseller Subscription API", "endpointPrefix": "", "latency": 0, "port": 3000, "hostname": "", "routes": [ { "uuid": "07d42dc7-b304-4ea6-9b68-a1d974ea3341", "documentation": "Used by partners to get a subscription by id. It should be called directly by the partner using service accounts.", "method": "get", "endpoint": "v1/:name", "responses": [ { "uuid": "a3ae55c2-e28b-4f17-83e5-d585d513eb79", "body": "{\n \"cancellationDetails\": {\n \"reason\": \"{{oneOf (array 'CANCELLATION_REASON_UNSPECIFIED' 'CANCELLATION_REASON_FRAUD' 'CANCELLATION_REASON_REMORSE' 'CANCELLATION_REASON_ACCIDENTAL_PURCHASE' 'CANCELLATION_REASON_PAST_DUE' 'CANCELLATION_REASON_ACCOUNT_CLOSED' 'CANCELLATION_REASON_UPGRADE_DOWNGRADE' 'CANCELLATION_REASON_USER_DELINQUENCY' 'CANCELLATION_REASON_OTHER')}}\"\n },\n \"createTime\": \"\",\n \"cycleEndTime\": \"\",\n \"endUserEntitled\": {{faker 'datatype.boolean'}},\n \"freeTrialEndTime\": \"\",\n \"lineItems\": [\n {\n \"description\": \"\",\n \"lineItemFreeTrialEndTime\": \"\",\n \"lineItemPromotionSpecs\": [\n {\n \"freeTrialDuration\": {\n \"count\": {{faker 'number.int' max=99999}},\n \"unit\": \"{{oneOf (array 'UNIT_UNSPECIFIED' 'MONTH' 'DAY')}}\"\n },\n \"introductoryPricingDetails\": {\n \"introductoryPricingSpecs\": [\n {\n \"discountAmount\": {\n \"amountMicros\": \"\",\n \"currencyCode\": \"\"\n },\n \"discountRatioMicros\": \"\",\n \"recurrenceCount\": {{faker 'number.int' max=99999}},\n \"regionCode\": \"\"\n }\n ]\n },\n \"promotion\": \"\",\n \"type\": \"{{oneOf (array 'PROMOTION_TYPE_UNSPECIFIED' 'PROMOTION_TYPE_FREE_TRIAL' 'PROMOTION_TYPE_INTRODUCTORY_PRICING')}}\"\n }\n ],\n \"oneTimeRecurrenceDetails\": {\n \"servicePeriod\": {\n \"endTime\": \"\",\n \"startTime\": \"\"\n }\n },\n \"product\": \"\",\n \"recurrenceType\": \"{{oneOf (array 'LINE_ITEM_RECURRENCE_TYPE_UNSPECIFIED' 'LINE_ITEM_RECURRENCE_TYPE_PERIODIC' 'LINE_ITEM_RECURRENCE_TYPE_ONE_TIME')}}\",\n \"state\": \"{{oneOf (array 'LINE_ITEM_STATE_UNSPECIFIED' 'LINE_ITEM_STATE_ACTIVE' 'LINE_ITEM_STATE_INACTIVE' 'LINE_ITEM_STATE_NEW' 'LINE_ITEM_STATE_ACTIVATING' 'LINE_ITEM_STATE_DEACTIVATING')}}\"\n }\n ],\n \"name\": \"\",\n \"partnerUserToken\": \"\",\n \"processingState\": \"{{oneOf (array 'PROCESSING_STATE_UNSPECIFIED' 'PROCESSING_STATE_CANCELLING' 'PROCESSING_STATE_RECURRING')}}\",\n \"products\": [\n \"\"\n ],\n \"promotionSpecs\": [\n {\n \"freeTrialDuration\": {\n \"count\": {{faker 'number.int' max=99999}},\n \"unit\": \"{{oneOf (array 'UNIT_UNSPECIFIED' 'MONTH' 'DAY')}}\"\n },\n \"introductoryPricingDetails\": {\n \"introductoryPricingSpecs\": [\n {\n \"discountAmount\": {\n \"amountMicros\": \"\",\n \"currencyCode\": \"\"\n },\n \"discountRatioMicros\": \"\",\n \"recurrenceCount\": {{faker 'number.int' max=99999}},\n \"regionCode\": \"\"\n }\n ]\n },\n \"promotion\": \"\",\n \"type\": \"{{oneOf (array 'PROMOTION_TYPE_UNSPECIFIED' 'PROMOTION_TYPE_FREE_TRIAL' 'PROMOTION_TYPE_INTRODUCTORY_PRICING')}}\"\n }\n ],\n \"promotions\": [\n \"\"\n ],\n \"redirectUri\": \"\",\n \"renewalTime\": \"\",\n \"serviceLocation\": {\n \"postalCode\": \"\",\n \"regionCode\": \"\"\n },\n \"state\": \"{{oneOf (array 'STATE_UNSPECIFIED' 'STATE_CREATED' 'STATE_ACTIVE' 'STATE_CANCELLED' 'STATE_IN_GRACE_PERIOD' 'STATE_CANCEL_AT_END_OF_CYCLE' 'STATE_SUSPENDED')}}\",\n \"updateTime\": \"\",\n \"upgradeDowngradeDetails\": {\n \"billingCycleSpec\": \"{{oneOf (array 'BILLING_CYCLE_SPEC_UNSPECIFIED' 'BILLING_CYCLE_SPEC_ALIGN_WITH_PREVIOUS_SUBSCRIPTION' 'BILLING_CYCLE_SPEC_START_IMMEDIATELY')}}\",\n \"previousSubscriptionId\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "ed5e8eaa-652f-4d93-922f-4d57e8851bc8", "documentation": "Used by partners to cancel a subscription service either immediately or by the end of the current billing cycle for their customers. It should be called directly by the partner using service accounts.", "method": "post", "endpoint": "v1/:name:cancel", "responses": [ { "uuid": "c4b0f389-8aca-45c0-bb4f-d5c5bbaabf08", "body": "{\n \"subscription\": {\n \"cancellationDetails\": {\n \"reason\": \"{{oneOf (array 'CANCELLATION_REASON_UNSPECIFIED' 'CANCELLATION_REASON_FRAUD' 'CANCELLATION_REASON_REMORSE' 'CANCELLATION_REASON_ACCIDENTAL_PURCHASE' 'CANCELLATION_REASON_PAST_DUE' 'CANCELLATION_REASON_ACCOUNT_CLOSED' 'CANCELLATION_REASON_UPGRADE_DOWNGRADE' 'CANCELLATION_REASON_USER_DELINQUENCY' 'CANCELLATION_REASON_OTHER')}}\"\n },\n \"createTime\": \"\",\n \"cycleEndTime\": \"\",\n \"endUserEntitled\": {{faker 'datatype.boolean'}},\n \"freeTrialEndTime\": \"\",\n \"lineItems\": [\n {\n \"description\": \"\",\n \"lineItemFreeTrialEndTime\": \"\",\n \"lineItemPromotionSpecs\": [\n {\n \"freeTrialDuration\": {\n \"count\": {{faker 'number.int' max=99999}},\n \"unit\": \"{{oneOf (array 'UNIT_UNSPECIFIED' 'MONTH' 'DAY')}}\"\n },\n \"introductoryPricingDetails\": {\n \"introductoryPricingSpecs\": [\n {\n \"discountAmount\": {\n \"amountMicros\": \"\",\n \"currencyCode\": \"\"\n },\n \"discountRatioMicros\": \"\",\n \"recurrenceCount\": {{faker 'number.int' max=99999}},\n \"regionCode\": \"\"\n }\n ]\n },\n \"promotion\": \"\",\n \"type\": \"{{oneOf (array 'PROMOTION_TYPE_UNSPECIFIED' 'PROMOTION_TYPE_FREE_TRIAL' 'PROMOTION_TYPE_INTRODUCTORY_PRICING')}}\"\n }\n ],\n \"oneTimeRecurrenceDetails\": {\n \"servicePeriod\": {\n \"endTime\": \"\",\n \"startTime\": \"\"\n }\n },\n \"product\": \"\",\n \"recurrenceType\": \"{{oneOf (array 'LINE_ITEM_RECURRENCE_TYPE_UNSPECIFIED' 'LINE_ITEM_RECURRENCE_TYPE_PERIODIC' 'LINE_ITEM_RECURRENCE_TYPE_ONE_TIME')}}\",\n \"state\": \"{{oneOf (array 'LINE_ITEM_STATE_UNSPECIFIED' 'LINE_ITEM_STATE_ACTIVE' 'LINE_ITEM_STATE_INACTIVE' 'LINE_ITEM_STATE_NEW' 'LINE_ITEM_STATE_ACTIVATING' 'LINE_ITEM_STATE_DEACTIVATING')}}\"\n }\n ],\n \"name\": \"\",\n \"partnerUserToken\": \"\",\n \"processingState\": \"{{oneOf (array 'PROCESSING_STATE_UNSPECIFIED' 'PROCESSING_STATE_CANCELLING' 'PROCESSING_STATE_RECURRING')}}\",\n \"products\": [\n \"\"\n ],\n \"promotionSpecs\": [\n {\n \"freeTrialDuration\": {\n \"count\": {{faker 'number.int' max=99999}},\n \"unit\": \"{{oneOf (array 'UNIT_UNSPECIFIED' 'MONTH' 'DAY')}}\"\n },\n \"introductoryPricingDetails\": {\n \"introductoryPricingSpecs\": [\n {\n \"discountAmount\": {\n \"amountMicros\": \"\",\n \"currencyCode\": \"\"\n },\n \"discountRatioMicros\": \"\",\n \"recurrenceCount\": {{faker 'number.int' max=99999}},\n \"regionCode\": \"\"\n }\n ]\n },\n \"promotion\": \"\",\n \"type\": \"{{oneOf (array 'PROMOTION_TYPE_UNSPECIFIED' 'PROMOTION_TYPE_FREE_TRIAL' 'PROMOTION_TYPE_INTRODUCTORY_PRICING')}}\"\n }\n ],\n \"promotions\": [\n \"\"\n ],\n \"redirectUri\": \"\",\n \"renewalTime\": \"\",\n \"serviceLocation\": {\n \"postalCode\": \"\",\n \"regionCode\": \"\"\n },\n \"state\": \"{{oneOf (array 'STATE_UNSPECIFIED' 'STATE_CREATED' 'STATE_ACTIVE' 'STATE_CANCELLED' 'STATE_IN_GRACE_PERIOD' 'STATE_CANCEL_AT_END_OF_CYCLE' 'STATE_SUSPENDED')}}\",\n \"updateTime\": \"\",\n \"upgradeDowngradeDetails\": {\n \"billingCycleSpec\": \"{{oneOf (array 'BILLING_CYCLE_SPEC_UNSPECIFIED' 'BILLING_CYCLE_SPEC_ALIGN_WITH_PREVIOUS_SUBSCRIPTION' 'BILLING_CYCLE_SPEC_START_IMMEDIATELY')}}\",\n \"previousSubscriptionId\": \"\"\n }\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "b815f439-8cc6-49f5-829b-72683e2ac141", "documentation": "Used by partners to entitle a previously provisioned subscription to the current end user. The end user identity is inferred from the authorized credential of the request. This API must be authorized by the end user using OAuth.", "method": "post", "endpoint": "v1/:name:entitle", "responses": [ { "uuid": "c0da7231-172c-4cb2-b8d3-3a41e6612b8c", "body": "{\n \"subscription\": {\n \"cancellationDetails\": {\n \"reason\": \"{{oneOf (array 'CANCELLATION_REASON_UNSPECIFIED' 'CANCELLATION_REASON_FRAUD' 'CANCELLATION_REASON_REMORSE' 'CANCELLATION_REASON_ACCIDENTAL_PURCHASE' 'CANCELLATION_REASON_PAST_DUE' 'CANCELLATION_REASON_ACCOUNT_CLOSED' 'CANCELLATION_REASON_UPGRADE_DOWNGRADE' 'CANCELLATION_REASON_USER_DELINQUENCY' 'CANCELLATION_REASON_OTHER')}}\"\n },\n \"createTime\": \"\",\n \"cycleEndTime\": \"\",\n \"endUserEntitled\": {{faker 'datatype.boolean'}},\n \"freeTrialEndTime\": \"\",\n \"lineItems\": [\n {\n \"description\": \"\",\n \"lineItemFreeTrialEndTime\": \"\",\n \"lineItemPromotionSpecs\": [\n {\n \"freeTrialDuration\": {\n \"count\": {{faker 'number.int' max=99999}},\n \"unit\": \"{{oneOf (array 'UNIT_UNSPECIFIED' 'MONTH' 'DAY')}}\"\n },\n \"introductoryPricingDetails\": {\n \"introductoryPricingSpecs\": [\n {\n \"discountAmount\": {\n \"amountMicros\": \"\",\n \"currencyCode\": \"\"\n },\n \"discountRatioMicros\": \"\",\n \"recurrenceCount\": {{faker 'number.int' max=99999}},\n \"regionCode\": \"\"\n }\n ]\n },\n \"promotion\": \"\",\n \"type\": \"{{oneOf (array 'PROMOTION_TYPE_UNSPECIFIED' 'PROMOTION_TYPE_FREE_TRIAL' 'PROMOTION_TYPE_INTRODUCTORY_PRICING')}}\"\n }\n ],\n \"oneTimeRecurrenceDetails\": {\n \"servicePeriod\": {\n \"endTime\": \"\",\n \"startTime\": \"\"\n }\n },\n \"product\": \"\",\n \"recurrenceType\": \"{{oneOf (array 'LINE_ITEM_RECURRENCE_TYPE_UNSPECIFIED' 'LINE_ITEM_RECURRENCE_TYPE_PERIODIC' 'LINE_ITEM_RECURRENCE_TYPE_ONE_TIME')}}\",\n \"state\": \"{{oneOf (array 'LINE_ITEM_STATE_UNSPECIFIED' 'LINE_ITEM_STATE_ACTIVE' 'LINE_ITEM_STATE_INACTIVE' 'LINE_ITEM_STATE_NEW' 'LINE_ITEM_STATE_ACTIVATING' 'LINE_ITEM_STATE_DEACTIVATING')}}\"\n }\n ],\n \"name\": \"\",\n \"partnerUserToken\": \"\",\n \"processingState\": \"{{oneOf (array 'PROCESSING_STATE_UNSPECIFIED' 'PROCESSING_STATE_CANCELLING' 'PROCESSING_STATE_RECURRING')}}\",\n \"products\": [\n \"\"\n ],\n \"promotionSpecs\": [\n {\n \"freeTrialDuration\": {\n \"count\": {{faker 'number.int' max=99999}},\n \"unit\": \"{{oneOf (array 'UNIT_UNSPECIFIED' 'MONTH' 'DAY')}}\"\n },\n \"introductoryPricingDetails\": {\n \"introductoryPricingSpecs\": [\n {\n \"discountAmount\": {\n \"amountMicros\": \"\",\n \"currencyCode\": \"\"\n },\n \"discountRatioMicros\": \"\",\n \"recurrenceCount\": {{faker 'number.int' max=99999}},\n \"regionCode\": \"\"\n }\n ]\n },\n \"promotion\": \"\",\n \"type\": \"{{oneOf (array 'PROMOTION_TYPE_UNSPECIFIED' 'PROMOTION_TYPE_FREE_TRIAL' 'PROMOTION_TYPE_INTRODUCTORY_PRICING')}}\"\n }\n ],\n \"promotions\": [\n \"\"\n ],\n \"redirectUri\": \"\",\n \"renewalTime\": \"\",\n \"serviceLocation\": {\n \"postalCode\": \"\",\n \"regionCode\": \"\"\n },\n \"state\": \"{{oneOf (array 'STATE_UNSPECIFIED' 'STATE_CREATED' 'STATE_ACTIVE' 'STATE_CANCELLED' 'STATE_IN_GRACE_PERIOD' 'STATE_CANCEL_AT_END_OF_CYCLE' 'STATE_SUSPENDED')}}\",\n \"updateTime\": \"\",\n \"upgradeDowngradeDetails\": {\n \"billingCycleSpec\": \"{{oneOf (array 'BILLING_CYCLE_SPEC_UNSPECIFIED' 'BILLING_CYCLE_SPEC_ALIGN_WITH_PREVIOUS_SUBSCRIPTION' 'BILLING_CYCLE_SPEC_START_IMMEDIATELY')}}\",\n \"previousSubscriptionId\": \"\"\n }\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "52f10ec9-3773-484a-b411-1e24a635cfb1", "documentation": "Used by partners to extend a subscription service for their customers on an ongoing basis for the subscription to remain active and renewable. It should be called directly by the partner using service accounts.", "method": "post", "endpoint": "v1/:name:extend", "responses": [ { "uuid": "02d402b4-9445-44be-b7cd-476ce50b6bec", "body": "{\n \"cycleEndTime\": \"\",\n \"freeTrialEndTime\": \"\",\n \"renewalTime\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "abc800ab-fe5b-448c-85da-690384d57c82", "documentation": "Used by partners to revoke the pending cancellation of a subscription, which is currently in `STATE_CANCEL_AT_END_OF_CYCLE` state. If the subscription is already cancelled, the request will fail. It should be called directly by the partner using service accounts.", "method": "post", "endpoint": "v1/:name:undoCancel", "responses": [ { "uuid": "9525163c-b739-418d-b076-f41d5018d296", "body": "{\n \"subscription\": {\n \"cancellationDetails\": {\n \"reason\": \"{{oneOf (array 'CANCELLATION_REASON_UNSPECIFIED' 'CANCELLATION_REASON_FRAUD' 'CANCELLATION_REASON_REMORSE' 'CANCELLATION_REASON_ACCIDENTAL_PURCHASE' 'CANCELLATION_REASON_PAST_DUE' 'CANCELLATION_REASON_ACCOUNT_CLOSED' 'CANCELLATION_REASON_UPGRADE_DOWNGRADE' 'CANCELLATION_REASON_USER_DELINQUENCY' 'CANCELLATION_REASON_OTHER')}}\"\n },\n \"createTime\": \"\",\n \"cycleEndTime\": \"\",\n \"endUserEntitled\": {{faker 'datatype.boolean'}},\n \"freeTrialEndTime\": \"\",\n \"lineItems\": [\n {\n \"description\": \"\",\n \"lineItemFreeTrialEndTime\": \"\",\n \"lineItemPromotionSpecs\": [\n {\n \"freeTrialDuration\": {\n \"count\": {{faker 'number.int' max=99999}},\n \"unit\": \"{{oneOf (array 'UNIT_UNSPECIFIED' 'MONTH' 'DAY')}}\"\n },\n \"introductoryPricingDetails\": {\n \"introductoryPricingSpecs\": [\n {\n \"discountAmount\": {\n \"amountMicros\": \"\",\n \"currencyCode\": \"\"\n },\n \"discountRatioMicros\": \"\",\n \"recurrenceCount\": {{faker 'number.int' max=99999}},\n \"regionCode\": \"\"\n }\n ]\n },\n \"promotion\": \"\",\n \"type\": \"{{oneOf (array 'PROMOTION_TYPE_UNSPECIFIED' 'PROMOTION_TYPE_FREE_TRIAL' 'PROMOTION_TYPE_INTRODUCTORY_PRICING')}}\"\n }\n ],\n \"oneTimeRecurrenceDetails\": {\n \"servicePeriod\": {\n \"endTime\": \"\",\n \"startTime\": \"\"\n }\n },\n \"product\": \"\",\n \"recurrenceType\": \"{{oneOf (array 'LINE_ITEM_RECURRENCE_TYPE_UNSPECIFIED' 'LINE_ITEM_RECURRENCE_TYPE_PERIODIC' 'LINE_ITEM_RECURRENCE_TYPE_ONE_TIME')}}\",\n \"state\": \"{{oneOf (array 'LINE_ITEM_STATE_UNSPECIFIED' 'LINE_ITEM_STATE_ACTIVE' 'LINE_ITEM_STATE_INACTIVE' 'LINE_ITEM_STATE_NEW' 'LINE_ITEM_STATE_ACTIVATING' 'LINE_ITEM_STATE_DEACTIVATING')}}\"\n }\n ],\n \"name\": \"\",\n \"partnerUserToken\": \"\",\n \"processingState\": \"{{oneOf (array 'PROCESSING_STATE_UNSPECIFIED' 'PROCESSING_STATE_CANCELLING' 'PROCESSING_STATE_RECURRING')}}\",\n \"products\": [\n \"\"\n ],\n \"promotionSpecs\": [\n {\n \"freeTrialDuration\": {\n \"count\": {{faker 'number.int' max=99999}},\n \"unit\": \"{{oneOf (array 'UNIT_UNSPECIFIED' 'MONTH' 'DAY')}}\"\n },\n \"introductoryPricingDetails\": {\n \"introductoryPricingSpecs\": [\n {\n \"discountAmount\": {\n \"amountMicros\": \"\",\n \"currencyCode\": \"\"\n },\n \"discountRatioMicros\": \"\",\n \"recurrenceCount\": {{faker 'number.int' max=99999}},\n \"regionCode\": \"\"\n }\n ]\n },\n \"promotion\": \"\",\n \"type\": \"{{oneOf (array 'PROMOTION_TYPE_UNSPECIFIED' 'PROMOTION_TYPE_FREE_TRIAL' 'PROMOTION_TYPE_INTRODUCTORY_PRICING')}}\"\n }\n ],\n \"promotions\": [\n \"\"\n ],\n \"redirectUri\": \"\",\n \"renewalTime\": \"\",\n \"serviceLocation\": {\n \"postalCode\": \"\",\n \"regionCode\": \"\"\n },\n \"state\": \"{{oneOf (array 'STATE_UNSPECIFIED' 'STATE_CREATED' 'STATE_ACTIVE' 'STATE_CANCELLED' 'STATE_IN_GRACE_PERIOD' 'STATE_CANCEL_AT_END_OF_CYCLE' 'STATE_SUSPENDED')}}\",\n \"updateTime\": \"\",\n \"upgradeDowngradeDetails\": {\n \"billingCycleSpec\": \"{{oneOf (array 'BILLING_CYCLE_SPEC_UNSPECIFIED' 'BILLING_CYCLE_SPEC_ALIGN_WITH_PREVIOUS_SUBSCRIPTION' 'BILLING_CYCLE_SPEC_START_IMMEDIATELY')}}\",\n \"previousSubscriptionId\": \"\"\n }\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "c862ddd8-af98-4199-a67a-4cd11cda818e", "documentation": "To retrieve the products that can be resold by the partner. It should be autenticated with a service account.", "method": "get", "endpoint": "v1/:parent/products", "responses": [ { "uuid": "5ed72666-56ff-4ce6-860a-a1c28cb255e0", "body": "{\n \"nextPageToken\": \"\",\n \"products\": [\n {\n \"name\": \"\",\n \"priceConfigs\": [\n {\n \"amount\": {\n \"amountMicros\": \"\",\n \"currencyCode\": \"\"\n },\n \"regionCode\": \"\"\n }\n ],\n \"regionCodes\": [\n \"\"\n ],\n \"subscriptionBillingCycleDuration\": {\n \"count\": {{faker 'number.int' max=99999}},\n \"unit\": \"{{oneOf (array 'UNIT_UNSPECIFIED' 'MONTH' 'DAY')}}\"\n },\n \"titles\": [\n {\n \"languageCode\": \"\",\n \"text\": \"\"\n }\n ]\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "90c8e188-35f0-4b41-8ef7-2b1feede197c", "documentation": "To retrieve the promotions, such as free trial, that can be used by the partner. It should be autenticated with a service account.", "method": "get", "endpoint": "v1/:parent/promotions", "responses": [ { "uuid": "723c85c3-f308-4b7d-a09f-4d33c492917e", "body": "{\n \"nextPageToken\": \"\",\n \"promotions\": [\n {\n \"applicableProducts\": [\n \"\"\n ],\n \"endTime\": \"\",\n \"freeTrialDuration\": {\n \"count\": {{faker 'number.int' max=99999}},\n \"unit\": \"{{oneOf (array 'UNIT_UNSPECIFIED' 'MONTH' 'DAY')}}\"\n },\n \"introductoryPricingDetails\": {\n \"introductoryPricingSpecs\": [\n {\n \"discountAmount\": {\n \"amountMicros\": \"\",\n \"currencyCode\": \"\"\n },\n \"discountRatioMicros\": \"\",\n \"recurrenceCount\": {{faker 'number.int' max=99999}},\n \"regionCode\": \"\"\n }\n ]\n },\n \"name\": \"\",\n \"promotionType\": \"{{oneOf (array 'PROMOTION_TYPE_UNSPECIFIED' 'PROMOTION_TYPE_FREE_TRIAL' 'PROMOTION_TYPE_INTRODUCTORY_PRICING')}}\",\n \"regionCodes\": [\n \"\"\n ],\n \"startTime\": \"\",\n \"titles\": [\n {\n \"languageCode\": \"\",\n \"text\": \"\"\n }\n ]\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "67dc9741-7b32-49eb-b9dd-71772fddb8f9", "documentation": "To find eligible promotions for the current user. The API requires user authorization via OAuth. The user is inferred from the authenticated OAuth credential.", "method": "post", "endpoint": "v1/:parent/promotions:findEligible", "responses": [ { "uuid": "8df474b6-d318-4c6f-8468-6c71f802a2b6", "body": "{\n \"nextPageToken\": \"\",\n \"promotions\": [\n {\n \"applicableProducts\": [\n \"\"\n ],\n \"endTime\": \"\",\n \"freeTrialDuration\": {\n \"count\": {{faker 'number.int' max=99999}},\n \"unit\": \"{{oneOf (array 'UNIT_UNSPECIFIED' 'MONTH' 'DAY')}}\"\n },\n \"introductoryPricingDetails\": {\n \"introductoryPricingSpecs\": [\n {\n \"discountAmount\": {\n \"amountMicros\": \"\",\n \"currencyCode\": \"\"\n },\n \"discountRatioMicros\": \"\",\n \"recurrenceCount\": {{faker 'number.int' max=99999}},\n \"regionCode\": \"\"\n }\n ]\n },\n \"name\": \"\",\n \"promotionType\": \"{{oneOf (array 'PROMOTION_TYPE_UNSPECIFIED' 'PROMOTION_TYPE_FREE_TRIAL' 'PROMOTION_TYPE_INTRODUCTORY_PRICING')}}\",\n \"regionCodes\": [\n \"\"\n ],\n \"startTime\": \"\",\n \"titles\": [\n {\n \"languageCode\": \"\",\n \"text\": \"\"\n }\n ]\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "3cbdb8bf-263a-44b8-9754-940fd54a4097", "documentation": "Used by partners to create a subscription for their customers. The created subscription is associated with the end user inferred from the end user credentials. This API must be authorized by the end user using OAuth.", "method": "post", "endpoint": "v1/:parent/subscriptions", "responses": [ { "uuid": "594b6b0f-e83e-4b1e-86ca-165123ef7d01", "body": "{\n \"cancellationDetails\": {\n \"reason\": \"{{oneOf (array 'CANCELLATION_REASON_UNSPECIFIED' 'CANCELLATION_REASON_FRAUD' 'CANCELLATION_REASON_REMORSE' 'CANCELLATION_REASON_ACCIDENTAL_PURCHASE' 'CANCELLATION_REASON_PAST_DUE' 'CANCELLATION_REASON_ACCOUNT_CLOSED' 'CANCELLATION_REASON_UPGRADE_DOWNGRADE' 'CANCELLATION_REASON_USER_DELINQUENCY' 'CANCELLATION_REASON_OTHER')}}\"\n },\n \"createTime\": \"\",\n \"cycleEndTime\": \"\",\n \"endUserEntitled\": {{faker 'datatype.boolean'}},\n \"freeTrialEndTime\": \"\",\n \"lineItems\": [\n {\n \"description\": \"\",\n \"lineItemFreeTrialEndTime\": \"\",\n \"lineItemPromotionSpecs\": [\n {\n \"freeTrialDuration\": {\n \"count\": {{faker 'number.int' max=99999}},\n \"unit\": \"{{oneOf (array 'UNIT_UNSPECIFIED' 'MONTH' 'DAY')}}\"\n },\n \"introductoryPricingDetails\": {\n \"introductoryPricingSpecs\": [\n {\n \"discountAmount\": {\n \"amountMicros\": \"\",\n \"currencyCode\": \"\"\n },\n \"discountRatioMicros\": \"\",\n \"recurrenceCount\": {{faker 'number.int' max=99999}},\n \"regionCode\": \"\"\n }\n ]\n },\n \"promotion\": \"\",\n \"type\": \"{{oneOf (array 'PROMOTION_TYPE_UNSPECIFIED' 'PROMOTION_TYPE_FREE_TRIAL' 'PROMOTION_TYPE_INTRODUCTORY_PRICING')}}\"\n }\n ],\n \"oneTimeRecurrenceDetails\": {\n \"servicePeriod\": {\n \"endTime\": \"\",\n \"startTime\": \"\"\n }\n },\n \"product\": \"\",\n \"recurrenceType\": \"{{oneOf (array 'LINE_ITEM_RECURRENCE_TYPE_UNSPECIFIED' 'LINE_ITEM_RECURRENCE_TYPE_PERIODIC' 'LINE_ITEM_RECURRENCE_TYPE_ONE_TIME')}}\",\n \"state\": \"{{oneOf (array 'LINE_ITEM_STATE_UNSPECIFIED' 'LINE_ITEM_STATE_ACTIVE' 'LINE_ITEM_STATE_INACTIVE' 'LINE_ITEM_STATE_NEW' 'LINE_ITEM_STATE_ACTIVATING' 'LINE_ITEM_STATE_DEACTIVATING')}}\"\n }\n ],\n \"name\": \"\",\n \"partnerUserToken\": \"\",\n \"processingState\": \"{{oneOf (array 'PROCESSING_STATE_UNSPECIFIED' 'PROCESSING_STATE_CANCELLING' 'PROCESSING_STATE_RECURRING')}}\",\n \"products\": [\n \"\"\n ],\n \"promotionSpecs\": [\n {\n \"freeTrialDuration\": {\n \"count\": {{faker 'number.int' max=99999}},\n \"unit\": \"{{oneOf (array 'UNIT_UNSPECIFIED' 'MONTH' 'DAY')}}\"\n },\n \"introductoryPricingDetails\": {\n \"introductoryPricingSpecs\": [\n {\n \"discountAmount\": {\n \"amountMicros\": \"\",\n \"currencyCode\": \"\"\n },\n \"discountRatioMicros\": \"\",\n \"recurrenceCount\": {{faker 'number.int' max=99999}},\n \"regionCode\": \"\"\n }\n ]\n },\n \"promotion\": \"\",\n \"type\": \"{{oneOf (array 'PROMOTION_TYPE_UNSPECIFIED' 'PROMOTION_TYPE_FREE_TRIAL' 'PROMOTION_TYPE_INTRODUCTORY_PRICING')}}\"\n }\n ],\n \"promotions\": [\n \"\"\n ],\n \"redirectUri\": \"\",\n \"renewalTime\": \"\",\n \"serviceLocation\": {\n \"postalCode\": \"\",\n \"regionCode\": \"\"\n },\n \"state\": \"{{oneOf (array 'STATE_UNSPECIFIED' 'STATE_CREATED' 'STATE_ACTIVE' 'STATE_CANCELLED' 'STATE_IN_GRACE_PERIOD' 'STATE_CANCEL_AT_END_OF_CYCLE' 'STATE_SUSPENDED')}}\",\n \"updateTime\": \"\",\n \"upgradeDowngradeDetails\": {\n \"billingCycleSpec\": \"{{oneOf (array 'BILLING_CYCLE_SPEC_UNSPECIFIED' 'BILLING_CYCLE_SPEC_ALIGN_WITH_PREVIOUS_SUBSCRIPTION' 'BILLING_CYCLE_SPEC_START_IMMEDIATELY')}}\",\n \"previousSubscriptionId\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "6517979a-9022-48ad-97f7-e9e17645de21", "documentation": "Used by partners to provision a subscription for their customers. This creates a subscription without associating it with the end user account. EntitleSubscription must be called separately using OAuth in order for the end user account to be associated with the subscription. It should be called directly by the partner using service accounts.", "method": "post", "endpoint": "v1/:parent/subscriptions:provision", "responses": [ { "uuid": "835acb1b-63a9-4227-a245-3c04c2fb5578", "body": "{\n \"cancellationDetails\": {\n \"reason\": \"{{oneOf (array 'CANCELLATION_REASON_UNSPECIFIED' 'CANCELLATION_REASON_FRAUD' 'CANCELLATION_REASON_REMORSE' 'CANCELLATION_REASON_ACCIDENTAL_PURCHASE' 'CANCELLATION_REASON_PAST_DUE' 'CANCELLATION_REASON_ACCOUNT_CLOSED' 'CANCELLATION_REASON_UPGRADE_DOWNGRADE' 'CANCELLATION_REASON_USER_DELINQUENCY' 'CANCELLATION_REASON_OTHER')}}\"\n },\n \"createTime\": \"\",\n \"cycleEndTime\": \"\",\n \"endUserEntitled\": {{faker 'datatype.boolean'}},\n \"freeTrialEndTime\": \"\",\n \"lineItems\": [\n {\n \"description\": \"\",\n \"lineItemFreeTrialEndTime\": \"\",\n \"lineItemPromotionSpecs\": [\n {\n \"freeTrialDuration\": {\n \"count\": {{faker 'number.int' max=99999}},\n \"unit\": \"{{oneOf (array 'UNIT_UNSPECIFIED' 'MONTH' 'DAY')}}\"\n },\n \"introductoryPricingDetails\": {\n \"introductoryPricingSpecs\": [\n {\n \"discountAmount\": {\n \"amountMicros\": \"\",\n \"currencyCode\": \"\"\n },\n \"discountRatioMicros\": \"\",\n \"recurrenceCount\": {{faker 'number.int' max=99999}},\n \"regionCode\": \"\"\n }\n ]\n },\n \"promotion\": \"\",\n \"type\": \"{{oneOf (array 'PROMOTION_TYPE_UNSPECIFIED' 'PROMOTION_TYPE_FREE_TRIAL' 'PROMOTION_TYPE_INTRODUCTORY_PRICING')}}\"\n }\n ],\n \"oneTimeRecurrenceDetails\": {\n \"servicePeriod\": {\n \"endTime\": \"\",\n \"startTime\": \"\"\n }\n },\n \"product\": \"\",\n \"recurrenceType\": \"{{oneOf (array 'LINE_ITEM_RECURRENCE_TYPE_UNSPECIFIED' 'LINE_ITEM_RECURRENCE_TYPE_PERIODIC' 'LINE_ITEM_RECURRENCE_TYPE_ONE_TIME')}}\",\n \"state\": \"{{oneOf (array 'LINE_ITEM_STATE_UNSPECIFIED' 'LINE_ITEM_STATE_ACTIVE' 'LINE_ITEM_STATE_INACTIVE' 'LINE_ITEM_STATE_NEW' 'LINE_ITEM_STATE_ACTIVATING' 'LINE_ITEM_STATE_DEACTIVATING')}}\"\n }\n ],\n \"name\": \"\",\n \"partnerUserToken\": \"\",\n \"processingState\": \"{{oneOf (array 'PROCESSING_STATE_UNSPECIFIED' 'PROCESSING_STATE_CANCELLING' 'PROCESSING_STATE_RECURRING')}}\",\n \"products\": [\n \"\"\n ],\n \"promotionSpecs\": [\n {\n \"freeTrialDuration\": {\n \"count\": {{faker 'number.int' max=99999}},\n \"unit\": \"{{oneOf (array 'UNIT_UNSPECIFIED' 'MONTH' 'DAY')}}\"\n },\n \"introductoryPricingDetails\": {\n \"introductoryPricingSpecs\": [\n {\n \"discountAmount\": {\n \"amountMicros\": \"\",\n \"currencyCode\": \"\"\n },\n \"discountRatioMicros\": \"\",\n \"recurrenceCount\": {{faker 'number.int' max=99999}},\n \"regionCode\": \"\"\n }\n ]\n },\n \"promotion\": \"\",\n \"type\": \"{{oneOf (array 'PROMOTION_TYPE_UNSPECIFIED' 'PROMOTION_TYPE_FREE_TRIAL' 'PROMOTION_TYPE_INTRODUCTORY_PRICING')}}\"\n }\n ],\n \"promotions\": [\n \"\"\n ],\n \"redirectUri\": \"\",\n \"renewalTime\": \"\",\n \"serviceLocation\": {\n \"postalCode\": \"\",\n \"regionCode\": \"\"\n },\n \"state\": \"{{oneOf (array 'STATE_UNSPECIFIED' 'STATE_CREATED' 'STATE_ACTIVE' 'STATE_CANCELLED' 'STATE_IN_GRACE_PERIOD' 'STATE_CANCEL_AT_END_OF_CYCLE' 'STATE_SUSPENDED')}}\",\n \"updateTime\": \"\",\n \"upgradeDowngradeDetails\": {\n \"billingCycleSpec\": \"{{oneOf (array 'BILLING_CYCLE_SPEC_UNSPECIFIED' 'BILLING_CYCLE_SPEC_ALIGN_WITH_PREVIOUS_SUBSCRIPTION' 'BILLING_CYCLE_SPEC_START_IMMEDIATELY')}}\",\n \"previousSubscriptionId\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" } ], "proxyMode": false, "proxyHost": "", "proxyRemovePrefix": false, "tlsOptions": { "enabled": false, "type": "CERT", "pfxPath": "", "certPath": "", "keyPath": "", "caPath": "", "passphrase": "" }, "cors": true, "headers": [], "proxyReqHeaders": [{ "key": "", "value": "" }], "proxyResHeaders": [{ "key": "", "value": "" }], "data": [], "folders": [], "rootChildren": [ { "type": "route", "uuid": "07d42dc7-b304-4ea6-9b68-a1d974ea3341" }, { "type": "route", "uuid": "ed5e8eaa-652f-4d93-922f-4d57e8851bc8" }, { "type": "route", "uuid": "b815f439-8cc6-49f5-829b-72683e2ac141" }, { "type": "route", "uuid": "52f10ec9-3773-484a-b411-1e24a635cfb1" }, { "type": "route", "uuid": "abc800ab-fe5b-448c-85da-690384d57c82" }, { "type": "route", "uuid": "c862ddd8-af98-4199-a67a-4cd11cda818e" }, { "type": "route", "uuid": "90c8e188-35f0-4b41-8ef7-2b1feede197c" }, { "type": "route", "uuid": "67dc9741-7b32-49eb-b9dd-71772fddb8f9" }, { "type": "route", "uuid": "3cbdb8bf-263a-44b8-9754-940fd54a4097" }, { "type": "route", "uuid": "6517979a-9022-48ad-97f7-e9e17645de21" } ] }