--- title: /payments/pricing/amberflo/migrate-prepaid-credits slug: amberflo-api/paymentspricingamberflomigrate-prepaid-credits docTags: createdAt: 2024-11-07T15:10:16.976Z --- { "id": "sEtc4nmfuZmk8IppoFbuX", "type": "api-oas-v2", "data": { "method": "POST", "url": "https://app.amberflo.io/payments/pricing/amberflo/migrate-prepaid-credits", "servers": [ { "url": "https://app.amberflo.io/payments/pricing/amberflo/migrate-prepaid-credits" } ], "name": "", "description": "", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [], "queryParameters": [], "bodyDataParameters": [ { "kind": "optional", "name": "body", "type": "array", "description": "", "customType": "payment.pricing.prepaid_migration.ExistingExternalPrepaidCardByPrice.in[]", "schema": [ { "name": "id", "kind": "required", "type": "string", "description": "ID associated with the request. This will be turned into the prepaid card's URI.", "example": "" }, { "name": "customerId", "kind": "required", "type": "string", "description": "Customer ID.", "example": "" }, { "name": "creditsPurchasedInBaseCurrency", "kind": "required", "type": "number", "description": "Credits purchased in base currency.", "example": "" }, { "name": "creditsRemaining", "kind": "required", "type": "number", "description": "Remaining purchased credits.", "example": "" }, { "name": "paymentId", "kind": "required", "type": "string", "description": "Payment ID.", "example": "" }, { "name": "paymentSystemName", "kind": "required", "type": "string", "description": "Payment system name.", "example": "" }, { "name": "startTimeInSeconds", "kind": "required", "type": "integer", "description": "Prepaid card start time in seconds.", "example": 0 }, { "name": "expirationTimeInSeconds", "kind": "required", "type": "integer", "description": "Prepaid card expiration time in seconds.", "example": 0 }, { "name": "label", "kind": "optional", "type": "string", "description": "Prepaid card label.", "example": "" }, { "name": "customPriority", "kind": "optional", "type": "number", "description": "Explicit prepaid card priority.", "example": "" }, { "name": "prepaidPriority", "kind": "optional", "type": "string", "description": "Relative prepaid card priority. This value takes precedence over customPriority. If both are null then the lowest priority is assumed.", "modelRef": "#/components/schemas/payment.pricing.prepaid.PrepaidPriority.in", "customType": "payment.pricing.prepaid.PrepaidPriority.in", "schema": [] }, { "name": "prepaidConditions", "kind": "optional", "type": "object", "description": "Prepaid conditions.", "modelRef": "#/components/schemas/payment.billing.prepaid_to_product.PrepaidConditions.in", "customType": "payment.billing.prepaid_to_product.PrepaidConditions.in", "schema": [ { "name": "prepaidConditionsList", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/payment.billing.prepaid_to_product.PrepaidCondition.in", "customType": "payment.billing.prepaid_to_product.PrepaidCondition.in[]", "schema": [], "complexType": "oneOf", "complexItems": [ { "name": "payment.billing.prepaid_to_product.DimensionValueMapPrepaidCondition.in", "description": "", "modelRef": "#/components/schemas/payment.billing.prepaid_to_product.DimensionValueMapPrepaidCondition.in", "schema": [ { "name": "type", "kind": "optional", "type": "string", "example": "", "default": "DimensionValueMapPrepaidCondition" }, { "name": "dimensionMapValue", "kind": "optional", "type": "map", "example": "", "customType": "map", "schema": [] } ] }, { "name": "payment.billing.prepaid_to_product.ProductItemDimensionPrepaidCondition.in", "description": "", "modelRef": "#/components/schemas/payment.billing.prepaid_to_product.ProductItemDimensionPrepaidCondition.in", "schema": [ { "name": "type", "kind": "optional", "type": "string", "example": "", "default": "ProductItemDimensionPrepaidCondition" }, { "name": "productItemId", "kind": "optional", "type": "string", "description": "The product item associated with the prepaid.", "example": "" }, { "name": "dimensions", "kind": "optional", "type": "map", "description": "The dimensions associated with the prepaid.", "example": "", "customType": "map", "schema": [] } ] }, { "name": "payment.billing.prepaid_to_product.ProductItemPrepaidCondition.in", "description": "", "modelRef": "#/components/schemas/payment.billing.prepaid_to_product.ProductItemPrepaidCondition.in", "schema": [ { "name": "type", "kind": "optional", "type": "string", "example": "", "default": "ProductItemPrepaidCondition" }, { "name": "productItemId", "kind": "optional", "type": "string", "example": "" } ] } ] }, { "name": "prepaidConditionsHistory", "kind": "optional", "type": "map", "example": "", "customType": "map", "schema": [] } ] }, { "name": "paymentCurrencyCode", "kind": "optional", "type": "string", "description": "Prepaid price payment currency code. If null then the account's base currency will be used.", "example": "USD" }, { "name": "priceInPaymentCurrency", "kind": "optional", "type": "number", "description": "The price the customer paid for the prepaid card in the specified payment currency. If null then creditsPurchasedInBaseCurrency will be used.", "example": "" } ], "modelRef": "#/components/schemas/payment.pricing.prepaid_migration.ExistingExternalPrepaidCardByPrice.in", "isExpanded": true } ], "formDataParameters": [], "oAuthParameters": [ { "id": "apiKey", "name": "X-API-KEY", "kind": "optional", "type": "apiKey", "in": "header" } ] }, "responses": [ { "statusCode": "200", "description": "Successful request", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "array", "description": "", "customType": "payment.billing.prepaid_to_product.PrepaidCard.out[]", "schema": [], "modelRef": "#/components/schemas/payment.billing.prepaid_to_product.PrepaidCard.out", "complexItems": [ { "name": "object", "schema": [ { "name": "prepaidUri", "kind": "optional", "type": "string", "example": "" }, { "name": "paymentStatus", "kind": "optional", "type": "string", "description": "", "modelRef": "#/components/schemas/payment.payment.PaymentStatus.out", "customType": "payment.payment.PaymentStatus.out", "schema": [] }, { "name": "price", "kind": "optional", "type": "number", "example": "" }, { "name": "worth", "kind": "optional", "type": "number", "example": "" }, { "name": "sourceUri", "kind": "optional", "type": "string", "example": "" }, { "name": "paymentSystemName", "kind": "optional", "type": "string", "example": "" }, { "name": "paymentId", "kind": "optional", "type": "string", "example": "" }, { "name": "startTimeInSeconds", "kind": "optional", "type": "integer", "example": 0 }, { "name": "expirationTimeInSeconds", "kind": "optional", "type": "integer", "example": 0 }, { "name": "productInvoices", "kind": "optional", "type": "array", "description": "", "modelRef": "#/components/schemas/payment.billing.detailed.EntityProductInvoice.out", "customType": "payment.billing.detailed.EntityProductInvoice.out[]", "schema": [ { "name": "invoiceUri", "kind": "optional", "type": "string", "example": "" }, { "name": "createdTimeInSeconds", "kind": "optional", "type": "integer", "example": 0 }, { "name": "amount", "kind": "optional", "type": "number", "example": "" }, { "name": "invoiceAmount", "kind": "optional", "type": "number", "example": "" } ] }, { "name": "transferInvoices", "kind": "optional", "type": "array", "description": "", "modelRef": "#/components/schemas/payment.billing.detailed.PrepaidTransferInvoice.out", "customType": "payment.billing.detailed.PrepaidTransferInvoice.out[]", "schema": [ { "name": "requestId", "kind": "optional", "type": "string", "example": "" }, { "name": "destinationPrepaidUri", "kind": "optional", "type": "string", "example": "" }, { "name": "createdTimeInSeconds", "kind": "optional", "type": "integer", "example": 0 }, { "name": "amount", "kind": "optional", "type": "number", "example": "" } ] }, { "name": "usedAmount", "kind": "optional", "type": "number", "example": "" }, { "name": "amountLeft", "kind": "optional", "type": "number", "example": "" }, { "name": "cardType", "kind": "optional", "type": "string", "description": "", "modelRef": "#/components/schemas/payment.billing.prepaid_to_product.PrepaidCardType.out", "customType": "payment.billing.prepaid_to_product.PrepaidCardType.out", "schema": [] }, { "name": "paymentCurrencyInfo", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/payment.billing.PaymentCurrencyInfo.out", "customType": "payment.billing.PaymentCurrencyInfo.out", "schema": [ { "name": "basePlanCurrency", "kind": "optional", "type": "string", "description": "Currency code in ISO 4217 format.", "example": "USD" }, { "name": "paymentCurrency", "kind": "optional", "type": "string", "description": "Currency code in ISO 4217 format.", "example": "USD" }, { "name": "exchangeRate", "kind": "optional", "type": "number", "example": "" } ] }, { "name": "prepaidConditions", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/payment.billing.prepaid_to_product.PrepaidConditions.out", "customType": "payment.billing.prepaid_to_product.PrepaidConditions.out", "schema": [ { "name": "prepaidConditionsList", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/payment.billing.prepaid_to_product.PrepaidCondition.out", "customType": "payment.billing.prepaid_to_product.PrepaidCondition.out[]", "schema": [], "complexType": "oneOf", "complexItems": [ { "name": "payment.billing.prepaid_to_product.DimensionValueMapPrepaidCondition.out", "description": "", "modelRef": "#/components/schemas/payment.billing.prepaid_to_product.DimensionValueMapPrepaidCondition.out", "schema": [ { "name": "type", "kind": "optional", "type": "string", "example": "", "default": "DimensionValueMapPrepaidCondition" }, { "name": "dimensionMapValue", "kind": "optional", "type": "map", "example": "", "customType": "map", "schema": [] } ] }, { "name": "payment.billing.prepaid_to_product.ProductItemDimensionPrepaidCondition.out", "description": "", "modelRef": "#/components/schemas/payment.billing.prepaid_to_product.ProductItemDimensionPrepaidCondition.out", "schema": [ { "name": "type", "kind": "optional", "type": "string", "example": "", "default": "ProductItemDimensionPrepaidCondition" }, { "name": "productItemId", "kind": "optional", "type": "string", "description": "The product item associated with the prepaid.", "example": "" }, { "name": "dimensions", "kind": "optional", "type": "map", "description": "The dimensions associated with the prepaid.", "example": "", "customType": "map", "schema": [] } ] }, { "name": "payment.billing.prepaid_to_product.ProductItemPrepaidCondition.out", "description": "", "modelRef": "#/components/schemas/payment.billing.prepaid_to_product.ProductItemPrepaidCondition.out", "schema": [ { "name": "type", "kind": "optional", "type": "string", "example": "", "default": "ProductItemPrepaidCondition" }, { "name": "productItemId", "kind": "optional", "type": "string", "example": "" } ] } ] }, { "name": "prepaidConditionsHistory", "kind": "optional", "type": "map", "example": "", "customType": "map", "schema": [] } ] }, { "name": "label", "kind": "optional", "type": "string", "example": "" }, { "name": "commitmentId", "kind": "optional", "type": "string", "example": "" }, { "name": "customPriority", "kind": "optional", "type": "number", "example": "" }, { "name": "startAtMidCycle", "kind": "optional", "type": "boolean", "example": "" }, { "name": "orderId", "kind": "optional", "type": "string", "example": "" }, { "name": "orderItemId", "kind": "optional", "type": "string", "example": "" }, { "name": "realTimePricing", "kind": "optional", "type": "boolean", "example": "" }, { "name": "type", "kind": "optional", "type": "string", "example": "", "default": "prepaid_card_by_price" }, { "name": "purchaseType", "kind": "optional", "type": "string", "description": "", "modelRef": "#/components/schemas/payment.billing.prepaid_to_product.PrepaidPurchaseType.out", "customType": "payment.billing.prepaid_to_product.PrepaidPurchaseType.out", "schema": [] }, { "name": "actualPrepaidChargePrice", "kind": "optional", "type": "number", "description": "The actual absolute charge amount for the prepaid card, in base currency.", "example": "" } ], "modelRef": "#/components/schemas/payment.billing.prepaid_to_product.PrepaidCardByPrice.out", "customType": "payment.billing.prepaid_to_product.PrepaidCardByPrice.out" }, { "name": "object", "schema": [ { "name": "prepaidUri", "kind": "optional", "type": "string", "example": "" }, { "name": "paymentStatus", "kind": "optional", "type": "string", "description": "", "modelRef": "#/components/schemas/payment.payment.PaymentStatus.out", "customType": "payment.payment.PaymentStatus.out", "schema": [] }, { "name": "price", "kind": "optional", "type": "number", "example": "" }, { "name": "worth", "kind": "optional", "type": "number", "example": "" }, { "name": "sourceUri", "kind": "optional", "type": "string", "example": "" }, { "name": "paymentSystemName", "kind": "optional", "type": "string", "example": "" }, { "name": "paymentId", "kind": "optional", "type": "string", "example": "" }, { "name": "startTimeInSeconds", "kind": "optional", "type": "integer", "example": 0 }, { "name": "expirationTimeInSeconds", "kind": "optional", "type": "integer", "example": 0 }, { "name": "productInvoices", "kind": "optional", "type": "array", "description": "", "modelRef": "#/components/schemas/payment.billing.detailed.EntityProductInvoice.out", "customType": "payment.billing.detailed.EntityProductInvoice.out[]", "schema": [ { "name": "invoiceUri", "kind": "optional", "type": "string", "example": "" }, { "name": "createdTimeInSeconds", "kind": "optional", "type": "integer", "example": 0 }, { "name": "amount", "kind": "optional", "type": "number", "example": "" }, { "name": "invoiceAmount", "kind": "optional", "type": "number", "example": "" } ] }, { "name": "transferInvoices", "kind": "optional", "type": "array", "description": "", "modelRef": "#/components/schemas/payment.billing.detailed.PrepaidTransferInvoice.out", "customType": "payment.billing.detailed.PrepaidTransferInvoice.out[]", "schema": [ { "name": "requestId", "kind": "optional", "type": "string", "example": "" }, { "name": "destinationPrepaidUri", "kind": "optional", "type": "string", "example": "" }, { "name": "createdTimeInSeconds", "kind": "optional", "type": "integer", "example": 0 }, { "name": "amount", "kind": "optional", "type": "number", "example": "" } ] }, { "name": "usedAmount", "kind": "optional", "type": "number", "example": "" }, { "name": "amountLeft", "kind": "optional", "type": "number", "example": "" }, { "name": "cardType", "kind": "optional", "type": "string", "description": "", "modelRef": "#/components/schemas/payment.billing.prepaid_to_product.PrepaidCardType.out", "customType": "payment.billing.prepaid_to_product.PrepaidCardType.out", "schema": [] }, { "name": "paymentCurrencyInfo", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/payment.billing.PaymentCurrencyInfo.out", "customType": "payment.billing.PaymentCurrencyInfo.out", "schema": [ { "name": "basePlanCurrency", "kind": "optional", "type": "string", "description": "Currency code in ISO 4217 format.", "example": "USD" }, { "name": "paymentCurrency", "kind": "optional", "type": "string", "description": "Currency code in ISO 4217 format.", "example": "USD" }, { "name": "exchangeRate", "kind": "optional", "type": "number", "example": "" } ] }, { "name": "prepaidConditions", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/payment.billing.prepaid_to_product.PrepaidConditions.out", "customType": "payment.billing.prepaid_to_product.PrepaidConditions.out", "schema": [ { "name": "prepaidConditionsList", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/payment.billing.prepaid_to_product.PrepaidCondition.out", "customType": "payment.billing.prepaid_to_product.PrepaidCondition.out[]", "schema": [], "complexType": "oneOf", "complexItems": [ { "name": "payment.billing.prepaid_to_product.DimensionValueMapPrepaidCondition.out", "description": "", "modelRef": "#/components/schemas/payment.billing.prepaid_to_product.DimensionValueMapPrepaidCondition.out", "schema": [ { "name": "type", "kind": "optional", "type": "string", "example": "", "default": "DimensionValueMapPrepaidCondition" }, { "name": "dimensionMapValue", "kind": "optional", "type": "map", "example": "", "customType": "map", "schema": [] } ] }, { "name": "payment.billing.prepaid_to_product.ProductItemDimensionPrepaidCondition.out", "description": "", "modelRef": "#/components/schemas/payment.billing.prepaid_to_product.ProductItemDimensionPrepaidCondition.out", "schema": [ { "name": "type", "kind": "optional", "type": "string", "example": "", "default": "ProductItemDimensionPrepaidCondition" }, { "name": "productItemId", "kind": "optional", "type": "string", "description": "The product item associated with the prepaid.", "example": "" }, { "name": "dimensions", "kind": "optional", "type": "map", "description": "The dimensions associated with the prepaid.", "example": "", "customType": "map", "schema": [] } ] }, { "name": "payment.billing.prepaid_to_product.ProductItemPrepaidCondition.out", "description": "", "modelRef": "#/components/schemas/payment.billing.prepaid_to_product.ProductItemPrepaidCondition.out", "schema": [ { "name": "type", "kind": "optional", "type": "string", "example": "", "default": "ProductItemPrepaidCondition" }, { "name": "productItemId", "kind": "optional", "type": "string", "example": "" } ] } ] }, { "name": "prepaidConditionsHistory", "kind": "optional", "type": "map", "example": "", "customType": "map", "schema": [] } ] }, { "name": "label", "kind": "optional", "type": "string", "example": "" }, { "name": "commitmentId", "kind": "optional", "type": "string", "example": "" }, { "name": "customPriority", "kind": "optional", "type": "number", "example": "" }, { "name": "startAtMidCycle", "kind": "optional", "type": "boolean", "example": "" }, { "name": "orderId", "kind": "optional", "type": "string", "example": "" }, { "name": "orderItemId", "kind": "optional", "type": "string", "example": "" }, { "name": "realTimePricing", "kind": "optional", "type": "boolean", "example": "" }, { "name": "type", "kind": "optional", "type": "string", "example": "", "default": "prepaid_card_by_usage" }, { "name": "prepaidUsage", "kind": "optional", "type": "number", "example": "" }, { "name": "prepaidFullPrice", "kind": "optional", "type": "number", "example": "" }, { "name": "purchaseType", "kind": "optional", "type": "string", "description": "", "modelRef": "#/components/schemas/payment.billing.prepaid_to_product.PrepaidPurchaseType.out", "customType": "payment.billing.prepaid_to_product.PrepaidPurchaseType.out", "schema": [] } ], "modelRef": "#/components/schemas/payment.billing.prepaid_to_product.PrepaidCardByUsage.out", "customType": "payment.billing.prepaid_to_product.PrepaidCardByUsage.out" } ], "complexType": "oneOf", "isExpanded": true } ] } ], "examples": { "languages": [ { "id": "QvcMq8gz5tuP--VkIXYgD", "language": "curl", "label": "cURL", "code": "curl --request POST \\\n --url https://app.amberflo.io/payments/pricing/amberflo/migrate-prepaid-credits \\\n --header 'accept: application/json' \\\n --header 'content-type: application/json' \\\n --data '[\n {\n \"id\": \"\",\n \"customerId\": \"\",\n \"creditsPurchasedInBaseCurrency\": \"\",\n \"creditsRemaining\": \"\",\n \"paymentId\": \"\",\n \"paymentSystemName\": \"\",\n \"startTimeInSeconds\": 0,\n \"expirationTimeInSeconds\": 0\n }\n ]'" }, { "id": "mPLfKBQv1-R6k4S6FOUSO", "language": "javascript", "label": "javascript", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar raw = JSON.stringify([\n {\n \"id\": \"\",\n \"customerId\": \"\",\n \"creditsPurchasedInBaseCurrency\": \"\",\n \"creditsRemaining\": \"\",\n \"paymentId\": \"\",\n \"paymentSystemName\": \"\",\n \"startTimeInSeconds\": 0,\n \"expirationTimeInSeconds\": 0\n }\n]);\n\nvar requestOptions = {\n method: 'POST',\n headers: myHeaders,\n body: raw,\n redirect: 'follow'\n};\n\nfetch(\"https://app.amberflo.io/payments/pricing/amberflo/migrate-prepaid-credits\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "H9pcH4cBZabZJviYeibbL", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://app.amberflo.io/payments/pricing/amberflo/migrate-prepaid-credits\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Post.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\nrequest.body = JSON.dump([\n {\n \"id\": \"\",\n \"customerId\": \"\",\n \"creditsPurchasedInBaseCurrency\": \"\",\n \"creditsRemaining\": \"\",\n \"paymentId\": \"\",\n \"paymentSystemName\": \"\",\n \"startTimeInSeconds\": 0,\n \"expirationTimeInSeconds\": 0\n }\n])\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "_zcIc3Ey5PP1JrocsB_Lv", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://app.amberflo.io/payments/pricing/amberflo/migrate-prepaid-credits\"\n\npayload = json.dumps([\n {\n \"id\": \"\",\n \"customerId\": \"\",\n \"creditsPurchasedInBaseCurrency\": \"\",\n \"creditsRemaining\": \"\",\n \"paymentId\": \"\",\n \"paymentSystemName\": \"\",\n \"startTimeInSeconds\": 0,\n \"expirationTimeInSeconds\": 0\n }\n])\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"POST\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "QvcMq8gz5tuP--VkIXYgD" }, "results": { "languages": [ { "id": "FwYZ57aSV2y6q6LtsVPsp", "language": "200", "code": "// Successful request\n[\n \"\"\n]" } ], "selectedLanguageId": "FwYZ57aSV2y6q6LtsVPsp" } }, "children": [ { "text": "" } ] }