Skip to content

Commit

Permalink
DEVDOCS-6037: [UPDATE] updated Postman collection (#838)
Browse files Browse the repository at this point in the history 
<!-- Ticket number or summary of work -->
# [DEVDOCS-6037]


## What changed?

* Updated the unified billing postman collection 

## Release notes draft

* Updated the unified billing postman collection 
<!-- Provide an entry for the release notes using simple, conversational
language. Don't be too technical. Explain how the change will benefit
the merchant and link to the feature.

Examples:
* The newly-released [X feature] is now available to use. Now, you’ll be
able to [perform Y action].
* We're happy to announce [X feature], which can help you [perform Y
action].
* [X feature] helps you to create [Y response] using the [Z query
parameter]. Now, you can deliver [ex, localized shopping experiences for
your customers].
* Fixed a bug in the [X endpoint]. Now the [Y field] will appear when
you click [Z option]. -->
* 

## Anything else?
<!-- Add related PRs, salient notes, additional ticket numbers, etc. -->

ping {names}


[DEVDOCS-6037]:
https://bigcommercecloud.atlassian.net/browse/DEVDOCS-6037?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ
  • Loading branch information
@bc-traciporter
bc-traciporter authored Feb 28, 2025
1 parent 1421c73 commit 14b57cf
Showing 1 changed file with 10 additions and 10 deletions.
20 changes: 10 additions & 10 deletions docs/integrations/apps/unified-billing/postman-collection.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
We've integrated our sample app with Unified Billing to provide best practices for app developers. You can work with our [core sample app (GitHub)](https://github.com/bigcommerce/sample-app-nodejs).

```json filename="Unified Billing Postman collection" showLineNumbers copy
{
{
"info": {
"_postman_id": "9ae83029-8429-4cac-944e-630a27a99f52",
"name": "Unified Billing API",
Expand All @@ -13,7 +13,7 @@ We've integrated our sample app with Unified Billing to provide best practices f
},
"item": [
{
"name": "Create Checkout",
"name": "Checkout Query",
"request": {
"method": "POST",
"header": [
Expand All @@ -29,8 +29,8 @@ We've integrated our sample app with Unified Billing to provide best practices f
"body": {
"mode": "graphql",
"graphql": {
"query": "mutation ($checkout: CreateCheckoutInput!) {\n checkout {\n createCheckout(input: $checkout) {\n checkout {\n id\n accountId\n status\n checkoutUrl\n items(first: 1) {\n edges {\n node {\n subscriptionId\n status\n product {\n id\n type\n productLevel\n }\n scope {\n id\n type\n }\n pricingPlan {\n interval\n price {\n value\n currencyCode\n }\n trialDays\n }\n redirectUrl\n description\n }\n }\n }\n }\n }\n }\n}\n",
"variables": "{\n \"checkout\": {\n \"accountId\": \"bc/account/account/{{merchant_account_uuid}}\",\n \"items\": [\n {\n \"product\": {\n \"type\": \"APPLICATION\",\n \"id\": \"bc/account/product/{{application_id}}\",\n \"productLevel\": \"Standard Plan\"\n },\n \"scope\": {\n \"type\": \"STORE\",\n \"id\": \"bc/account/scope/{{store_hash}}\"\n },\n \"description\": \"App Name\",\n \"pricingPlan\": {\n \"interval\": \"MONTH\",\n \"price\": {\n \"value\": 3.99,\n \"currencyCode\": \"USD\"\n }\n },\n \"redirectUrl\": \"myapp.com\"\n }\n ]\n }\n}"
"query": "query q1($id: ID!) {\n account {\n checkout(id: $id) {\n id\n accountId\n status\n checkoutUrl\n items {\n edges {\n node {\n subscriptionId\n status\n product {\n id\n type\n }\n scope {\n id\n type\n }\n pricingPlan {\n interval\n price {\n value\n currencyCode\n }\n trialDays\n }\n redirectUrl\n description\n }\n }\n }\n }\n }\n}\n",
"variables": "{\n \"id\": \"bc/account/checkout/{{checkout_id}}\"\n}"
}
},
"url": {
Expand All @@ -49,7 +49,7 @@ We've integrated our sample app with Unified Billing to provide best practices f
"response": []
},
{
"name": "Checkout Query",
"name": "Subscriptions Query",
"request": {
"method": "POST",
"header": [
Expand All @@ -65,8 +65,8 @@ We've integrated our sample app with Unified Billing to provide best practices f
"body": {
"mode": "graphql",
"graphql": {
"query": "query q1($id: ID!) {\n account {\n checkout(id: $id) {\n id\n accountId\n status\n checkoutUrl\n items {\n edges {\n node {\n subscriptionId\n status\n product {\n id\n type\n }\n scope {\n id\n type\n }\n pricingPlan {\n interval\n price {\n value\n currencyCode\n }\n trialDays\n }\n redirectUrl\n description\n }\n }\n }\n }\n }\n}\n",
"variables": "{\n \"id\": \"bc/account/checkout/{{checkout_id}}\"\n}"
"query": "query ($filters: SubscriptionFiltersInput) {\n account {\n subscriptions(filters: $filters) {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n edges {\n cursor\n node {\n id\n accountId\n activationDate\n billingInterval\n currentPeriodEnd\n pricePerInterval {\n value\n currencyCode\n }\n product {\n productLevel\n id\n type\n }\n scope {\n type\n id\n }\n status\n createdAt\n updatedAt\n }\n }\n }\n }\n}\n",
"variables": "{\n \"filters\": {\n \"ids\": [\"bc/account/subscription/{{subscription_id}}\"],\n \"productId\": \"bc/account/product/{{application_id}}\",\n \"productType\": \"APPLICATION\",\n \"updatedAfter\": \"2024-10-21T11:00:00Z\",\n \"status\": \"ACTIVE\"\n }\n}"
}
},
"url": {
Expand All @@ -85,7 +85,7 @@ We've integrated our sample app with Unified Billing to provide best practices f
"response": []
},
{
"name": "Subscriptions Query",
"name": "Create Checkout",
"request": {
"method": "POST",
"header": [
Expand All @@ -101,8 +101,8 @@ We've integrated our sample app with Unified Billing to provide best practices f
"body": {
"mode": "graphql",
"graphql": {
"query": "query ($filters: SubscriptionFiltersInput) {\n account {\n subscriptions(filters: $filters) {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n edges {\n cursor\n node {\n id\n accountId\n activationDate\n billingInterval\n currentPeriodEnd\n pricePerInterval {\n value\n currencyCode\n }\n product {\n productLevel\n id\n type\n }\n scope {\n type\n id\n }\n status\n createdAt\n updatedAt\n }\n }\n }\n }\n}\n",
"variables": "{\n \"filters\": {\n \"ids\": [\"bc/account/subscription/{{subscription_id}}\"],\n \"productId\": \"bc/account/product/{{application_id}}\",\n \"productType\": \"APPLICATION\",\n \"updatedAfter\": \"2024-10-21T11:00:00Z\",\n \"status\": \"ACTIVE\"\n }\n}"
"query": "mutation ($checkout: CreateCheckoutInput!) {\n checkout {\n createCheckout(input: $checkout) {\n checkout {\n id\n accountId\n status\n checkoutUrl\n items(first: 1) {\n edges {\n node {\n subscriptionId\n status\n product {\n id\n type\n productLevel\n }\n scope {\n id\n type\n }\n pricingPlan {\n interval\n price {\n value\n currencyCode\n }\n trialDays\n }\n redirectUrl\n description\n }\n }\n }\n }\n }\n }\n}\n",
"variables": "{\n \"checkout\": {\n \"accountId\": \"bc/account/account/{{merchant_account_uuid}}\",\n \"items\": [\n {\n \"product\": {\n \"type\": \"APPLICATION\",\n \"id\": \"bc/account/product/{{application_id}}\",\n \"productLevel\": \"Standard Plan\"\n },\n \"scope\": {\n \"type\": \"STORE\",\n \"id\": \"bc/account/scope/{{store_hash}}\"\n },\n \"description\": \"App Name\",\n \"pricingPlan\": {\n \"interval\": \"MONTH\",\n \"price\": {\n \"value\": 3.99,\n \"currencyCode\": \"USD\"\n }\n },\n \"redirectUrl\": \"myapp.com\"\n }\n ]\n }\n}"
}
},
"url": {
Expand Down

0 comments on commit 14b57cf

Please sign in to comment.