Jump to

• Request
• Response

Update subscription

put

/ccstore/v1/selfservice/subscriptions/{subscriptionNumber}

Updates a subscription for the given subscriptionNumber.

Request

Supported Media Types

• application/json

Path Parameters

• subscriptionNumber(required): string
  The subscription number

Body ()

Update subscription payload

Root Schema : updateSubscriptionRequest

Type: object

Show Source

• BillToContactNumber: string
• creditCards: array creditCards
• PaymentMethod: string
• PONumber: string
• products: array products
• QuoteToContactId: string
• ShipToContactNumber: string
• WireNumber: string

{
    "type":"object",
    "properties":{
        "PONumber":{
            "type":"string"
        },
        "creditCards":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/creditCardInput"
            }
        },
        "QuoteToContactId":{
            "type":"string"
        },
        "BillToContactNumber":{
            "type":"string"
        },
        "PaymentMethod":{
            "type":"string"
        },
        "ShipToContactNumber":{
            "type":"string"
        },
        "WireNumber":{
            "type":"string"
        },
        "products":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/productUpdateItem"
            }
        }
    }
}

Nested Schema : creditCards

Type: array

Show Source

• Array of: object creditCardInput

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/creditCardInput"
    }
}

Nested Schema : products

Type: array

Show Source

• Array of: object productUpdateItem

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/productUpdateItem"
    }
}

Nested Schema : creditCardInput

Type: object

Show Source

• CreditCardPuid: string
• InstrAssignmentId(required): string

{
    "type":"object",
    "properties":{
        "InstrAssignmentId":{
            "type":"string"
        },
        "CreditCardPuid":{
            "type":"string"
        }
    },
    "required":[
        "InstrAssignmentId"
    ]
}

Nested Schema : productUpdateItem

Type: object

Show Source

• BillToContactNumber: string
• creditCards: array creditCards
• PaymentMethod: string
• PONumber: string
• ShipToContactNumber: string
• SubscriptionProductPuid(required): string
• WireNumber: string

{
    "type":"object",
    "properties":{
        "PONumber":{
            "type":"string"
        },
        "creditCards":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/creditCardInput"
            }
        },
        "SubscriptionProductPuid":{
            "type":"string"
        },
        "BillToContactNumber":{
            "type":"string"
        },
        "PaymentMethod":{
            "type":"string"
        },
        "ShipToContactNumber":{
            "type":"string"
        },
        "WireNumber":{
            "type":"string"
        }
    },
    "required":[
        "SubscriptionProductPuid"
    ]
}

Nested Schema : creditCards

Type: array

Show Source

• Array of: object creditCardInput

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/creditCardInput"
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful response

Body ()

Root Schema : subscriptionDetailsResponse

Type: object

Show Source

• BillToAccountId: string
• BillToContactId: string
• BillToContactName: string
• BillToContactNumber: string
• BillToPartyId: string
• BillToSiteUseId: string
• creditCards: object pagedCreditCards
• LastUpdateDate: string
• PaymentMethod: string
• PaymentMethodName: string
• PONumber: string
• products: object pagedProducts
• ShipToContactId: string
• ShipToContactName: string
• ShipToContactNumber: string
• ShipToContactPartyId: string
• ShipToParty: string
• WireNumber: string

{
    "type":"object",
    "properties":{
        "PONumber":{
            "type":"string"
        },
        "ShipToContactId":{
            "type":"string"
        },
        "ShipToContactName":{
            "type":"string"
        },
        "BillToSiteUseId":{
            "type":"string"
        },
        "ShipToContactPartyId":{
            "type":"string"
        },
        "ShipToContactNumber":{
            "type":"string"
        },
        "BillToContactId":{
            "type":"string"
        },
        "WireNumber":{
            "type":"string"
        },
        "PaymentMethodName":{
            "type":"string"
        },
        "products":{
            "$ref":"#/definitions/pagedProducts"
        },
        "creditCards":{
            "$ref":"#/definitions/pagedCreditCards"
        },
        "ShipToParty":{
            "type":"string"
        },
        "BillToContactName":{
            "type":"string"
        },
        "BillToAccountId":{
            "type":"string"
        },
        "BillToPartyId":{
            "type":"string"
        },
        "BillToContactNumber":{
            "type":"string"
        },
        "PaymentMethod":{
            "type":"string"
        },
        "LastUpdateDate":{
            "type":"string"
        }
    }
}

Nested Schema : pagedCreditCards

Type: object

Show Source

• count: integer
• hasMore: boolean
• items: array items
• limit: integer
• offset: integer

{
    "type":"object",
    "properties":{
        "offset":{
            "type":"integer"
        },
        "count":{
            "type":"integer"
        },
        "hasMore":{
            "type":"boolean"
        },
        "limit":{
            "type":"integer"
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/creditCardItem"
            }
        }
    }
}

Nested Schema : pagedProducts

Type: object

Show Source

• count: integer
• hasMore: boolean
• items: array items
• limit: integer
• offset: integer

{
    "type":"object",
    "properties":{
        "offset":{
            "type":"integer"
        },
        "count":{
            "type":"integer"
        },
        "hasMore":{
            "type":"boolean"
        },
        "limit":{
            "type":"integer"
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/subscriptionProductItem"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object creditCardItem

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/creditCardItem"
    }
}

Nested Schema : creditCardItem

Type: object

Show Source

• CardHolderName: string
• CreditCardPuid: string
• ExpirationDate: string
• InstrAssignmentId: string
• IssuerCode: string
• LastUpdateDate: string
• MaskedNumber: string

{
    "type":"object",
    "properties":{
        "InstrAssignmentId":{
            "type":"string"
        },
        "CreditCardPuid":{
            "type":"string"
        },
        "ExpirationDate":{
            "type":"string"
        },
        "MaskedNumber":{
            "type":"string"
        },
        "IssuerCode":{
            "type":"string"
        },
        "CardHolderName":{
            "type":"string"
        },
        "LastUpdateDate":{
            "type":"string"
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object subscriptionProductItem

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/subscriptionProductItem"
    }
}

Nested Schema : subscriptionProductItem

Type: object

Show Source

• BillToAccountId: string
• BillToContactId: string
• BillToContactName: string
• BillToContactNumber: string
• BillToPartyId: string
• creditCards: object pagedCreditCards
• LastUpdateDate: string
• PaymentMethod: string
• PaymentMethodName: string
• PONumber: string
• ShipToContactId: string
• ShipToContactName: string
• ShipToContactNumber: string
• ShipToContactPartyId: string
• ShipToPartyId: string
• SubscriptionProductPuid: string
• WireNumber: string

{
    "type":"object",
    "properties":{
        "PONumber":{
            "type":"string"
        },
        "ShipToContactId":{
            "type":"string"
        },
        "ShipToContactName":{
            "type":"string"
        },
        "SubscriptionProductPuid":{
            "type":"string"
        },
        "ShipToContactPartyId":{
            "type":"string"
        },
        "ShipToContactNumber":{
            "type":"string"
        },
        "ShipToPartyId":{
            "type":"string"
        },
        "BillToContactId":{
            "type":"string"
        },
        "WireNumber":{
            "type":"string"
        },
        "PaymentMethodName":{
            "type":"string"
        },
        "creditCards":{
            "$ref":"#/definitions/pagedCreditCards"
        },
        "BillToContactName":{
            "type":"string"
        },
        "BillToAccountId":{
            "type":"string"
        },
        "BillToPartyId":{
            "type":"string"
        },
        "BillToContactNumber":{
            "type":"string"
        },
        "PaymentMethod":{
            "type":"string"
        },
        "LastUpdateDate":{
            "type":"string"
        }
    }
}

400 Response

Bad request

Body ()

Root Schema : Error

Type: object

Show Source

• errorCode: string
  The numerical code identifying the error
• message: string
• moreInfo: string
  An optional non-localized message with more information
• status: string
  The HTTP status code

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

500 Response

Internal server error

Body ()

Root Schema : Error

Type: object

Show Source

• errorCode: string
  The numerical code identifying the error
• message: string
• moreInfo: string
  An optional non-localized message with more information
• status: string
  The HTTP status code

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Back to Top