Skip to main content
PUT
/
api
/
v1
/
subscriptions
/
{subscriptionId}
/
payment-method
결제수단 변경
curl --request PUT \
  --url https://api.steppay.kr/api/v1/subscriptions/{subscriptionId}/payment-method \
  --header 'Content-Type: application/json' \
  --header 'Secret-Token: <api-key>' \
  --data '
{
  "paymentGateway": "NAVER"
}
'
{
  "orderId": 123,
  "orderCode": "<string>",
  "type": "RECURRING",
  "paidAmount": 123,
  "returnedAmount": 123,
  "leftAmount": 123,
  "discountedAmount": 123,
  "productName": "<string>",
  "orderLogs": [
    {
      "id": 123,
      "type": "MANAGER",
      "content": "<string>",
      "createdAt": "2023-11-07T05:31:56Z"
    }
  ],
  "code": "<string>",
  "subscriptions": [
    {
      "id": 123,
      "status": "ACTIVE",
      "items": [
        {
          "id": 123,
          "productName": "<string>",
          "productType": "BOX",
          "isOnetimePurchasable": true,
          "featuredImageUrl": "<string>",
          "selectedProductOptionIds": [
            123
          ],
          "selectedProductOptionPrice": 123,
          "plan": {
            "name": "<string>",
            "description": "<string>",
            "detailDescription": "<string>",
            "isHiddenFromShop": true,
            "adminName": "<string>"
          },
          "price": 123,
          "currency": "<string>",
          "quantity": 123,
          "isAdditional": true,
          "keepWhenRenew": true,
          "hasOptions": true,
          "type": "SKU",
          "claimMethodType": "PRE",
          "priceType": "ONE_TIME",
          "selectedOptions": [
            123
          ],
          "code": "<string>",
          "selectedProductOptionLabel": "<string>",
          "maximumPurchaseQuantity": 123,
          "productCode": "<string>",
          "priceCode": "<string>",
          "parentSubscriptionItemCode": "<string>"
        }
      ],
      "price": {
        "id": 123,
        "code": "<string>",
        "price": 123,
        "currencyPrice": {},
        "type": "ONE_TIME",
        "enabledFirstSalePrice": true,
        "firstSalePrice": 123,
        "billingDate": 123,
        "maximumPurchaseQuantity": 123,
        "membershipExpirationDate": 123,
        "options": [
          {
            "id": 123,
            "price": 123,
            "name": "<string>",
            "productCode": "<string>",
            "type": "INITIALLY",
            "priceCode": "<string>",
            "priceName": "<string>",
            "productType": "BOX",
            "recurringDTO": {
              "id": 123,
              "intervalCount": 123,
              "aggregateUsageType": "SUM",
              "interval": "DAY",
              "usageType": "LICENSED"
            }
          }
        ],
        "volumes": [
          {
            "id": 123,
            "min": 123,
            "max": 123,
            "price": 123
          }
        ],
        "basicServing": 123,
        "bundlePrices": [
          {
            "product": {
              "id": 123,
              "code": "<string>",
              "status": "SALE",
              "combinedProducts": [
                {
                  "code": "<string>",
                  "type": "BOX",
                  "status": "SALE",
                  "name": "<string>",
                  "description": "<string>",
                  "options": [
                    {
                      "id": 123,
                      "name": "<string>",
                      "options": [
                        {
                          "id": 123,
                          "name": "<string>",
                          "price": 123,
                          "quantity": 123,
                          "parent": 123
                        }
                      ],
                      "depth": 123
                    }
                  ],
                  "prices": "<array>",
                  "createdAt": "2023-11-07T05:31:56Z",
                  "modifiedAt": "2023-11-07T05:31:56Z"
                }
              ],
              "optionGroups": [
                {
                  "id": 123,
                  "name": "<string>",
                  "options": [
                    {
                      "id": 123,
                      "name": "<string>",
                      "price": 123,
                      "quantity": 123,
                      "parent": 123
                    }
                  ],
                  "depth": 123
                }
              ],
              "useCombination": true,
              "optionCombinations": [
                {
                  "id": [
                    123
                  ],
                  "status": "SALE",
                  "quantity": 123,
                  "price": 123
                }
              ],
              "prices": "<array>",
              "createdAt": "2023-11-07T05:31:56Z",
              "enabledDemo": true,
              "demoPeriod": 123,
              "demoPeriodUnit": "DAY",
              "categories": [
                {
                  "categoryId": 123,
                  "name": "<string>"
                }
              ],
              "vendorUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "productOrder": 123,
              "isOnetimePurchasable": true,
              "eventBadge": [
                {
                  "event": "<string>",
                  "startDateTime": "2023-11-07T05:31:56Z",
                  "endDateTime": "2023-11-07T05:31:56Z"
                }
              ],
              "type": "BOX",
              "name": "<string>",
              "subTitle": "<string>",
              "featuredImageUrl": "<string>",
              "imageUrls": [
                "<string>"
              ],
              "description": "<string>",
              "summary": "<string>",
              "reasonOfReject": "<string>",
              "sku": "<string>",
              "quantity": 123,
              "modifiedAt": "2023-11-07T05:31:56Z",
              "notice": "<string>",
              "useWidget": {
                "useDemo": true,
                "useEventBadge": true,
                "useOnetimePurchasable": true,
                "useNotice": true
              },
              "groupId": 123,
              "countrySetting": {
                "id": 123,
                "countryCode": "<string>",
                "timezoneName": "<string>",
                "currencyCode": "<string>",
                "isDefault": true,
                "taxRate": 123
              },
              "availableRegions": [
                "AD"
              ],
              "shared": [
                "3c90c3cc-0d44-4b50-8888-8dd25736052a"
              ]
            },
            "price": "<unknown>"
          }
        ],
        "onetimeBundlePrice": 123,
        "currencyOnetimeBundlePrice": {},
        "order": 123,
        "unit": "<string>",
        "planName": "<string>",
        "planDescription": "<string>",
        "claimMethodType": "PRE",
        "whenToClaimType": "FIRST_PAYMENT",
        "membershipExpirationDateType": "DAY",
        "setupOption": {
          "id": 123,
          "price": 123,
          "currencyPrice": {},
          "claimMethodType": "PRE",
          "name": "<string>",
          "type": "INITIALLY"
        },
        "additionalBilling": {
          "id": 123,
          "type": "USAGE_BASED_WITH_RANGE",
          "ranges": [
            {
              "id": 123,
              "until": 123,
              "price": 123
            }
          ]
        },
        "recurring": {
          "id": 123,
          "intervalCount": 123,
          "aggregateUsageType": "SUM",
          "interval": "DAY",
          "usageType": "LICENSED"
        },
        "createdAt": "2023-11-07T05:31:56Z",
        "modifiedAt": "2023-11-07T05:31:56Z",
        "plan": {
          "name": "<string>",
          "description": "<string>",
          "detailDescription": "<string>",
          "isHiddenFromShop": true,
          "adminName": "<string>"
        },
        "firstSale": {
          "enabled": true,
          "price": 123,
          "currencyPrice": {}
        },
        "claim": {
          "methodType": "PRE",
          "whenToClaimType": "FIRST_PAYMENT",
          "billingDate": 123,
          "provideStartDay": 123
        }
      },
      "interval": "DAY",
      "intervalCount": 123,
      "startDate": "2023-11-07T05:31:56Z",
      "lastPaymentDate": "2023-11-07T05:31:56Z",
      "nextPaymentDate": "2023-11-07T05:31:56Z",
      "endDate": "2023-11-07T05:31:56Z",
      "trialEndDate": "2023-11-07T05:31:56Z"
    }
  ],
  "relatedOrders": [
    {
      "id": 123,
      "code": "<string>",
      "orderType": "RECURRING",
      "productName": "<string>",
      "paidAmount": 123,
      "items": [
        {
          "orderItemId": 123,
          "code": "<string>",
          "productName": "<string>",
          "plan": {
            "name": "<string>",
            "description": "<string>",
            "detailDescription": "<string>",
            "isHiddenFromShop": true,
            "adminName": "<string>"
          },
          "status": "CREATED",
          "amount": 123,
          "priceType": "ONE_TIME",
          "parentOrderItemCode": "<string>"
        }
      ],
      "createdAt": "2023-11-07T05:31:56Z",
      "currency": "<string>"
    }
  ],
  "currency": "<string>",
  "exchangeRate": 123,
  "region": {
    "name": "<string>",
    "currencies": [
      "<string>"
    ],
    "country": "<string>",
    "countryCode": "<string>",
    "language": "<string>",
    "state": "<string>"
  },
  "baseCurrency": "<string>",
  "items": [
    {
      "id": 123,
      "code": "<string>",
      "paidAmount": 123,
      "currency": "<string>",
      "quantity": 123,
      "status": "CREATED",
      "selectedProductOptionIds": [
        123
      ],
      "orderItemCode": "<string>",
      "orderedProductType": "BOX",
      "orderedProductName": "<string>",
      "orderedPlanName": "<string>",
      "minimumQuantity": 123,
      "price": {
        "id": 123,
        "code": "<string>",
        "price": 123,
        "currencyPrice": {},
        "type": "ONE_TIME",
        "enabledFirstSalePrice": true,
        "firstSalePrice": 123,
        "billingDate": 123,
        "maximumPurchaseQuantity": 123,
        "membershipExpirationDate": 123,
        "options": [
          {
            "id": 123,
            "price": 123,
            "name": "<string>",
            "productCode": "<string>",
            "type": "INITIALLY",
            "priceCode": "<string>",
            "priceName": "<string>",
            "productType": "BOX",
            "recurringDTO": {
              "id": 123,
              "intervalCount": 123,
              "aggregateUsageType": "SUM",
              "interval": "DAY",
              "usageType": "LICENSED"
            }
          }
        ],
        "volumes": [
          {
            "id": 123,
            "min": 123,
            "max": 123,
            "price": 123
          }
        ],
        "basicServing": 123,
        "bundlePrices": [
          {
            "product": {
              "id": 123,
              "code": "<string>",
              "status": "SALE",
              "combinedProducts": [
                {
                  "code": "<string>",
                  "type": "BOX",
                  "status": "SALE",
                  "name": "<string>",
                  "description": "<string>",
                  "options": [
                    {
                      "id": 123,
                      "name": "<string>",
                      "options": [
                        {
                          "id": 123,
                          "name": "<string>",
                          "price": 123,
                          "quantity": 123,
                          "parent": 123
                        }
                      ],
                      "depth": 123
                    }
                  ],
                  "prices": "<array>",
                  "createdAt": "2023-11-07T05:31:56Z",
                  "modifiedAt": "2023-11-07T05:31:56Z"
                }
              ],
              "optionGroups": [
                {
                  "id": 123,
                  "name": "<string>",
                  "options": [
                    {
                      "id": 123,
                      "name": "<string>",
                      "price": 123,
                      "quantity": 123,
                      "parent": 123
                    }
                  ],
                  "depth": 123
                }
              ],
              "useCombination": true,
              "optionCombinations": [
                {
                  "id": [
                    123
                  ],
                  "status": "SALE",
                  "quantity": 123,
                  "price": 123
                }
              ],
              "prices": "<array>",
              "createdAt": "2023-11-07T05:31:56Z",
              "enabledDemo": true,
              "demoPeriod": 123,
              "demoPeriodUnit": "DAY",
              "categories": [
                {
                  "categoryId": 123,
                  "name": "<string>"
                }
              ],
              "vendorUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "productOrder": 123,
              "isOnetimePurchasable": true,
              "eventBadge": [
                {
                  "event": "<string>",
                  "startDateTime": "2023-11-07T05:31:56Z",
                  "endDateTime": "2023-11-07T05:31:56Z"
                }
              ],
              "type": "BOX",
              "name": "<string>",
              "subTitle": "<string>",
              "featuredImageUrl": "<string>",
              "imageUrls": [
                "<string>"
              ],
              "description": "<string>",
              "summary": "<string>",
              "reasonOfReject": "<string>",
              "sku": "<string>",
              "quantity": 123,
              "modifiedAt": "2023-11-07T05:31:56Z",
              "notice": "<string>",
              "useWidget": {
                "useDemo": true,
                "useEventBadge": true,
                "useOnetimePurchasable": true,
                "useNotice": true
              },
              "groupId": 123,
              "countrySetting": {
                "id": 123,
                "countryCode": "<string>",
                "timezoneName": "<string>",
                "currencyCode": "<string>",
                "isDefault": true,
                "taxRate": 123
              },
              "availableRegions": [
                "AD"
              ],
              "shared": [
                "3c90c3cc-0d44-4b50-8888-8dd25736052a"
              ]
            },
            "price": "<unknown>"
          }
        ],
        "onetimeBundlePrice": 123,
        "currencyOnetimeBundlePrice": {},
        "order": 123,
        "unit": "<string>",
        "planName": "<string>",
        "planDescription": "<string>",
        "claimMethodType": "PRE",
        "whenToClaimType": "FIRST_PAYMENT",
        "membershipExpirationDateType": "DAY",
        "setupOption": {
          "id": 123,
          "price": 123,
          "currencyPrice": {},
          "claimMethodType": "PRE",
          "name": "<string>",
          "type": "INITIALLY"
        },
        "additionalBilling": {
          "id": 123,
          "type": "USAGE_BASED_WITH_RANGE",
          "ranges": [
            {
              "id": 123,
              "until": 123,
              "price": 123
            }
          ]
        },
        "recurring": {
          "id": 123,
          "intervalCount": 123,
          "aggregateUsageType": "SUM",
          "interval": "DAY",
          "usageType": "LICENSED"
        },
        "createdAt": "2023-11-07T05:31:56Z",
        "modifiedAt": "2023-11-07T05:31:56Z",
        "plan": {
          "name": "<string>",
          "description": "<string>",
          "detailDescription": "<string>",
          "isHiddenFromShop": true,
          "adminName": "<string>"
        },
        "firstSale": {
          "enabled": true,
          "price": 123,
          "currencyPrice": {}
        },
        "claim": {
          "methodType": "PRE",
          "whenToClaimType": "FIRST_PAYMENT",
          "billingDate": 123,
          "provideStartDay": 123
        }
      },
      "product": {
        "id": 123,
        "code": "<string>",
        "status": "SALE",
        "combinedProducts": [
          {
            "code": "<string>",
            "type": "BOX",
            "status": "SALE",
            "name": "<string>",
            "description": "<string>",
            "options": [
              {
                "id": 123,
                "name": "<string>",
                "options": [
                  {
                    "id": 123,
                    "name": "<string>",
                    "price": 123,
                    "quantity": 123,
                    "parent": 123
                  }
                ],
                "depth": 123
              }
            ],
            "prices": "<array>",
            "createdAt": "2023-11-07T05:31:56Z",
            "modifiedAt": "2023-11-07T05:31:56Z"
          }
        ],
        "optionGroups": [
          {
            "id": 123,
            "name": "<string>",
            "options": [
              {
                "id": 123,
                "name": "<string>",
                "price": 123,
                "quantity": 123,
                "parent": 123
              }
            ],
            "depth": 123
          }
        ],
        "useCombination": true,
        "optionCombinations": [
          {
            "id": [
              123
            ],
            "status": "SALE",
            "quantity": 123,
            "price": 123
          }
        ],
        "prices": "<array>",
        "createdAt": "2023-11-07T05:31:56Z",
        "enabledDemo": true,
        "demoPeriod": 123,
        "demoPeriodUnit": "DAY",
        "categories": [
          {
            "categoryId": 123,
            "name": "<string>"
          }
        ],
        "vendorUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "productOrder": 123,
        "isOnetimePurchasable": true,
        "eventBadge": [
          {
            "event": "<string>",
            "startDateTime": "2023-11-07T05:31:56Z",
            "endDateTime": "2023-11-07T05:31:56Z"
          }
        ],
        "type": "BOX",
        "name": "<string>",
        "subTitle": "<string>",
        "featuredImageUrl": "<string>",
        "imageUrls": [
          "<string>"
        ],
        "description": "<string>",
        "summary": "<string>",
        "reasonOfReject": "<string>",
        "sku": "<string>",
        "quantity": 123,
        "modifiedAt": "2023-11-07T05:31:56Z",
        "notice": "<string>",
        "useWidget": {
          "useDemo": true,
          "useEventBadge": true,
          "useOnetimePurchasable": true,
          "useNotice": true
        },
        "groupId": 123,
        "countrySetting": {
          "id": 123,
          "countryCode": "<string>",
          "timezoneName": "<string>",
          "currencyCode": "<string>",
          "isDefault": true,
          "taxRate": 123
        },
        "availableRegions": [
          "AD"
        ],
        "shared": [
          "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        ]
      },
      "type": "SKU",
      "featuredImageUrl": "<string>",
      "selectedProductOptionLabel": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "canceledDateTime": "2023-11-07T05:31:56Z",
      "modifiedAt": "2023-11-07T05:31:56Z",
      "discountName": "<string>",
      "relatedOrderItemId": 123,
      "priceSetupType": "INITIALLY",
      "demoCycle": {
        "num": 123,
        "type": "DAY"
      },
      "usedCount": 123,
      "usageFormula": "<string>",
      "deliveryCode": "<string>",
      "histories": [
        {
          "actor": "SYSTEM",
          "category": "CANCELLATION",
          "status": "<string>",
          "createdAt": "2023-11-07T05:31:56Z",
          "reason": "<string>"
        }
      ],
      "maximumQuantity": 123,
      "parentOrderItemCode": "<string>",
      "unitChangeHistory": [
        {
          "changedCount": 123,
          "days": 123
        }
      ],
      "unitCount": 123,
      "relatedSubscriptionItemId": 123
    }
  ],
  "customer": {
    "id": 123,
    "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "marketingSms": true,
    "marketingEmail": true,
    "marketingKakao": true,
    "attributes": {},
    "createdAt": "2023-11-07T05:31:56Z",
    "status": "NORMAL",
    "username": "<string>",
    "email": "<string>",
    "phone": "<string>",
    "shipping": {
      "name": "<string>",
      "phone": "<string>",
      "postcode": "<string>",
      "address1": "<string>",
      "address2": "<string>",
      "state": "<string>",
      "city": "<string>",
      "countryCode": "<string>"
    },
    "code": "<string>"
  },
  "paymentDate": "2023-11-07T05:31:56Z",
  "paymentDueDate": "2023-11-07T05:31:56Z",
  "purchaseDeadline": "2023-11-07T05:31:56Z",
  "shipping": {
    "name": "<string>",
    "phone": "<string>",
    "postcode": "<string>",
    "address1": "<string>",
    "address2": "<string>",
    "state": "<string>",
    "city": "<string>",
    "countryCode": "<string>"
  },
  "createdAt": "2023-11-07T05:31:56Z",
  "modifiedAt": "2023-11-07T05:31:56Z",
  "payment": {
    "amount": 123,
    "discount": 123,
    "paymentMethod": "CARD",
    "paymentDate": "2023-11-07T05:31:56Z",
    "paymentReturn": {},
    "paymentReceiptUrl": "<string>",
    "paymentGateway": "NAVER",
    "cardNumber": "<string>",
    "vbankDTO": {
      "bankName": "<string>",
      "accountNumber": "<string>",
      "accountName": "<string>",
      "bankDate": "2023-11-07T05:31:56Z",
      "bankCode": "<string>"
    },
    "niceCmsDTO": {
      "corporateManager": "<string>",
      "companyName": "<string>",
      "accountHolderSocialSecurityNumber": "<string>",
      "bankCode": "<string>",
      "bankAccount": "<string>",
      "date": "2023-11-07T05:31:56Z",
      "status": "ACCOUNT_PENDING",
      "companyRegistrationNumber": "<string>",
      "errorReturn": "<string>"
    },
    "customerDTO": {
      "id": 123,
      "orderCount": 123,
      "totalPurchasedPrice": 123,
      "orders": [
        {
          "id": 123,
          "type": "RECURRING",
          "productName": "<string>",
          "amount": 123,
          "claimMethodType": "PRE",
          "createdAt": "2023-11-07T05:31:56Z",
          "currency": "<string>"
        }
      ],
      "subscriptions": [
        {
          "id": 123,
          "code": "<string>",
          "items": [
            {
              "id": 123,
              "productName": "<string>",
              "productType": "BOX",
              "isOnetimePurchasable": true,
              "featuredImageUrl": "<string>",
              "selectedProductOptionIds": [
                123
              ],
              "selectedProductOptionPrice": 123,
              "plan": {
                "name": "<string>",
                "description": "<string>",
                "detailDescription": "<string>",
                "isHiddenFromShop": true,
                "adminName": "<string>"
              },
              "price": 123,
              "currency": "<string>",
              "quantity": 123,
              "isAdditional": true,
              "keepWhenRenew": true,
              "hasOptions": true,
              "type": "SKU",
              "claimMethodType": "PRE",
              "priceType": "ONE_TIME",
              "selectedOptions": [
                123
              ],
              "code": "<string>",
              "selectedProductOptionLabel": "<string>",
              "maximumPurchaseQuantity": 123,
              "productCode": "<string>",
              "priceCode": "<string>",
              "parentSubscriptionItemCode": "<string>"
            }
          ],
          "status": "ACTIVE",
          "recurring": {
            "interval": "DAY",
            "intervalCount": 123
          },
          "currency": "<string>",
          "nextPaymentDateTime": "2023-11-07T05:31:56Z",
          "paymentMethod": {
            "id": 123,
            "paymentInfo": "<string>"
          },
          "endDate": "2023-11-07T05:31:56Z",
          "lastPaymentDateTime": "2023-11-07T05:31:56Z"
        }
      ],
      "paymentMethods": [
        {
          "id": 123,
          "paymentInfo": "<string>"
        }
      ],
      "marketingSms": true,
      "marketingEmail": true,
      "marketingKakao": true,
      "attributes": {},
      "createdAt": "2023-11-07T05:31:56Z",
      "additionalRecipients": [
        "<string>"
      ],
      "region": {
        "name": "<string>",
        "currencies": [
          "<string>"
        ],
        "country": "<string>",
        "countryCode": "<string>",
        "language": "<string>",
        "state": "<string>"
      },
      "status": "NORMAL",
      "username": "<string>",
      "name": "<string>",
      "email": "<string>",
      "phone": "<string>",
      "shipping": {
        "name": "<string>",
        "phone": "<string>",
        "postcode": "<string>",
        "address1": "<string>",
        "address2": "<string>",
        "state": "<string>",
        "city": "<string>",
        "countryCode": "<string>"
      },
      "code": "<string>"
    },
    "errorCode": "<string>",
    "errorMessage": "<string>"
  },
  "idKey": "<string>",
  "parentSubscription": {
    "id": 123,
    "status": "ACTIVE",
    "items": [
      {
        "id": 123,
        "productName": "<string>",
        "productType": "BOX",
        "isOnetimePurchasable": true,
        "featuredImageUrl": "<string>",
        "selectedProductOptionIds": [
          123
        ],
        "selectedProductOptionPrice": 123,
        "plan": {
          "name": "<string>",
          "description": "<string>",
          "detailDescription": "<string>",
          "isHiddenFromShop": true,
          "adminName": "<string>"
        },
        "price": 123,
        "currency": "<string>",
        "quantity": 123,
        "isAdditional": true,
        "keepWhenRenew": true,
        "hasOptions": true,
        "type": "SKU",
        "claimMethodType": "PRE",
        "priceType": "ONE_TIME",
        "selectedOptions": [
          123
        ],
        "code": "<string>",
        "selectedProductOptionLabel": "<string>",
        "maximumPurchaseQuantity": 123,
        "productCode": "<string>",
        "priceCode": "<string>",
        "parentSubscriptionItemCode": "<string>"
      }
    ],
    "price": {
      "id": 123,
      "code": "<string>",
      "price": 123,
      "currencyPrice": {},
      "type": "ONE_TIME",
      "enabledFirstSalePrice": true,
      "firstSalePrice": 123,
      "billingDate": 123,
      "maximumPurchaseQuantity": 123,
      "membershipExpirationDate": 123,
      "options": [
        {
          "id": 123,
          "price": 123,
          "name": "<string>",
          "productCode": "<string>",
          "type": "INITIALLY",
          "priceCode": "<string>",
          "priceName": "<string>",
          "productType": "BOX",
          "recurringDTO": {
            "id": 123,
            "intervalCount": 123,
            "aggregateUsageType": "SUM",
            "interval": "DAY",
            "usageType": "LICENSED"
          }
        }
      ],
      "volumes": [
        {
          "id": 123,
          "min": 123,
          "max": 123,
          "price": 123
        }
      ],
      "basicServing": 123,
      "bundlePrices": [
        {
          "product": {
            "id": 123,
            "code": "<string>",
            "status": "SALE",
            "combinedProducts": [
              {
                "code": "<string>",
                "type": "BOX",
                "status": "SALE",
                "name": "<string>",
                "description": "<string>",
                "options": [
                  {
                    "id": 123,
                    "name": "<string>",
                    "options": [
                      {
                        "id": 123,
                        "name": "<string>",
                        "price": 123,
                        "quantity": 123,
                        "parent": 123
                      }
                    ],
                    "depth": 123
                  }
                ],
                "prices": "<array>",
                "createdAt": "2023-11-07T05:31:56Z",
                "modifiedAt": "2023-11-07T05:31:56Z"
              }
            ],
            "optionGroups": [
              {
                "id": 123,
                "name": "<string>",
                "options": [
                  {
                    "id": 123,
                    "name": "<string>",
                    "price": 123,
                    "quantity": 123,
                    "parent": 123
                  }
                ],
                "depth": 123
              }
            ],
            "useCombination": true,
            "optionCombinations": [
              {
                "id": [
                  123
                ],
                "status": "SALE",
                "quantity": 123,
                "price": 123
              }
            ],
            "prices": "<array>",
            "createdAt": "2023-11-07T05:31:56Z",
            "enabledDemo": true,
            "demoPeriod": 123,
            "demoPeriodUnit": "DAY",
            "categories": [
              {
                "categoryId": 123,
                "name": "<string>"
              }
            ],
            "vendorUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "productOrder": 123,
            "isOnetimePurchasable": true,
            "eventBadge": [
              {
                "event": "<string>",
                "startDateTime": "2023-11-07T05:31:56Z",
                "endDateTime": "2023-11-07T05:31:56Z"
              }
            ],
            "type": "BOX",
            "name": "<string>",
            "subTitle": "<string>",
            "featuredImageUrl": "<string>",
            "imageUrls": [
              "<string>"
            ],
            "description": "<string>",
            "summary": "<string>",
            "reasonOfReject": "<string>",
            "sku": "<string>",
            "quantity": 123,
            "modifiedAt": "2023-11-07T05:31:56Z",
            "notice": "<string>",
            "useWidget": {
              "useDemo": true,
              "useEventBadge": true,
              "useOnetimePurchasable": true,
              "useNotice": true
            },
            "groupId": 123,
            "countrySetting": {
              "id": 123,
              "countryCode": "<string>",
              "timezoneName": "<string>",
              "currencyCode": "<string>",
              "isDefault": true,
              "taxRate": 123
            },
            "availableRegions": [
              "AD"
            ],
            "shared": [
              "3c90c3cc-0d44-4b50-8888-8dd25736052a"
            ]
          },
          "price": "<unknown>"
        }
      ],
      "onetimeBundlePrice": 123,
      "currencyOnetimeBundlePrice": {},
      "order": 123,
      "unit": "<string>",
      "planName": "<string>",
      "planDescription": "<string>",
      "claimMethodType": "PRE",
      "whenToClaimType": "FIRST_PAYMENT",
      "membershipExpirationDateType": "DAY",
      "setupOption": {
        "id": 123,
        "price": 123,
        "currencyPrice": {},
        "claimMethodType": "PRE",
        "name": "<string>",
        "type": "INITIALLY"
      },
      "additionalBilling": {
        "id": 123,
        "type": "USAGE_BASED_WITH_RANGE",
        "ranges": [
          {
            "id": 123,
            "until": 123,
            "price": 123
          }
        ]
      },
      "recurring": {
        "id": 123,
        "intervalCount": 123,
        "aggregateUsageType": "SUM",
        "interval": "DAY",
        "usageType": "LICENSED"
      },
      "createdAt": "2023-11-07T05:31:56Z",
      "modifiedAt": "2023-11-07T05:31:56Z",
      "plan": {
        "name": "<string>",
        "description": "<string>",
        "detailDescription": "<string>",
        "isHiddenFromShop": true,
        "adminName": "<string>"
      },
      "firstSale": {
        "enabled": true,
        "price": 123,
        "currencyPrice": {}
      },
      "claim": {
        "methodType": "PRE",
        "whenToClaimType": "FIRST_PAYMENT",
        "billingDate": 123,
        "provideStartDay": 123
      }
    },
    "interval": "DAY",
    "intervalCount": 123,
    "startDate": "2023-11-07T05:31:56Z",
    "lastPaymentDate": "2023-11-07T05:31:56Z",
    "nextPaymentDate": "2023-11-07T05:31:56Z",
    "endDate": "2023-11-07T05:31:56Z",
    "trialEndDate": "2023-11-07T05:31:56Z"
  },
  "calculateStartDate": "2023-11-07T05:31:56Z",
  "calculateEndDate": "2023-11-07T05:31:56Z",
  "childOrders": "<array>",
  "paymentMethod": "CARD",
  "totalDisplayAmount": 123
}

Authorizations

​
Secret-Token
string
header
required

Path Parameters

​
subscriptionId
integer<int64>
required

구독 번호

Body

application/json

결제수단 변경 정보

​
paymentGateway
enum<string>

사용할 PG. 지정하면 지정된 PG만 사용할 수 있습니다. (기본값: UNKNOWN)

Available options:
NAVER,
DANAL,
KAKAO,
KG,
KCP,
NICE,
JT,
GOOGLE,
BANKPAY,
BLUEWALNUT,
KSNET,
TOSS,
EXIMBAY,
SETTLE,
DAOUDATA,
WELCOME,
NICE_V2,
STRIPE,
PAYPLE,
PAYPLE_GLOBAL,
KICC,
EMPTY,
STEPPAY,
UNKNOWN

Response

정상적으로 주문이 생성됨

청구서 주문 정보

​
orderId
integer<int64>
required

주문 번호

​
orderCode
string
required

주문 코드

​
type
enum<string>
required

주문 타입

Available options:
RECURRING,
ONE_TIME,
PAYMENT_METHOD,
RECURRING_INITIAL,
ADD_USAGE,
ADDITIONAL,
ADD_PAYMENT_METHOD
​
paidAmount
number
required

주문 금액

​
returnedAmount
number
required

환불된 금액

​
leftAmount
number
required

남은 금액

​
discountedAmount
number
required

할인 금액

​
productName
string
required

상품 이름

​
orderLogs
주문 메모 정보 · object[]
required

주문 메모 목록

​
code
string
required

주문 코드

​
subscriptions
주문 관련 구독 정보 · object[]
required

관련 구독 목록

​
relatedOrders
object[]
required

관련 주문

​
currency
string
required

결제 통화

​
exchangeRate
number
required

환율(금액에 곱할 값)

​
region
판매국가 정보 · object
required

지역

​
baseCurrency
string
required

주문 생성 당시 기준 통화

​
items
주문 항목 정보 · object[]

주문 항목들

​
customer
주문 고객 정보 · object

주문한 고객 정보

​
paymentDate
string<date-time>

결제 시점

​
paymentDueDate
string<date-time>

결제일 지정

​
purchaseDeadline
string<date-time>

청구서 사용시, 구매 기한 시점

​
shipping
배송지 정보 · object

고객이 최근에 사용한 배송지

​
createdAt
string<date-time>

생성된 시점

​
modifiedAt
string<date-time>

수정된 시점

​
payment
결제 상세 정보 · object

결제 상세 정보

​
idKey
string

결제 정보 조회용 idKey

​
parentSubscription
주문 관련 구독 정보 · object

부모 구독 정보(갱신 결제일 경우)

​
calculateStartDate
string<date-time>

합산 시작 시점

​
calculateEndDate
string<date-time>

합산 끝 시점

​
childOrders
array

하위 벤더의 주문

​
paymentMethod
enum<string>

결제 수단

Available options:
CARD,
VBANK,
BANK,
BANK_TRANSFER,
CELLPHONE,
SIMPLE_PAY,
CMS,
CARD_BILL,
CELLPHONE_BILL,
CMS_BILL,
PAYPAL
​
totalDisplayAmount
number

표시 통화 가격