Jump to

• Request
• Response

accountAssets

post

/ccadmin/v1/webhook/accountAssets

The webhook is triggered to get the services for a user.

Request

Supported Media Types

• application/json

Body ()

Root Schema : services_request

Type: object

Show Source

• accounts(optional): object accounts
• limit(optional): number
• offset(optional): number
• records(optional): array records

{
    "properties":{
        "offset":{
            "type":"number"
        },
        "records":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "recordId":{
                        "type":"string"
                    }
                }
            }
        },
        "limit":{
            "type":"number"
        },
        "accounts":{
            "type":"object",
            "properties":{
                "serviceAccountIds":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "id":{
                                "type":"string"
                            }
                        }
                    }
                },
                "customerAccountIds":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "id":{
                                "type":"string"
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : accounts

Type: object

Show Source

• customerAccountIds(optional): array customerAccountIds
• serviceAccountIds(optional): array serviceAccountIds

{
    "type":"object",
    "properties":{
        "serviceAccountIds":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "id":{
                        "type":"string"
                    }
                }
            }
        },
        "customerAccountIds":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "id":{
                        "type":"string"
                    }
                }
            }
        }
    }
}

Nested Schema : records

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "recordId":{
                "type":"string"
            }
        }
    }
}

Nested Schema : customerAccountIds

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "id":{
                "type":"string"
            }
        }
    }
}

Nested Schema : serviceAccountIds

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "id":{
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• id(optional): string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        }
    }
}

Nested Schema : items

Type: object

Show Source

• id(optional): string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        }
    }
}

Nested Schema : items

Type: object

Show Source

• recordId(optional): string

{
    "type":"object",
    "properties":{
        "recordId":{
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Returns the services associated with this account.

Body ()

Root Schema : services_response

Type: object

Show Source

• count(optional): integer
• hasMore(optional): boolean
• items(optional): array items
• limit(optional): integer
• offset(optional): integer
• totalResults(optional): integer

{
    "properties":{
        "totalResults":{
            "type":"integer"
        },
        "offset":{
            "type":"integer"
        },
        "count":{
            "type":"integer"
        },
        "hasMore":{
            "type":"boolean"
        },
        "limit":{
            "type":"integer"
        },
        "items":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "deactivationDate":{
                        "type":"string"
                    },
                    "rootDisplay":{
                        "type":"string"
                    },
                    "rootAsset":{
                        "type":"object",
                        "properties":{
                            "assetId":{
                                "type":"string"
                            },
                            "serviceId":{
                                "type":"string"
                            }
                        }
                    },
                    "displayName":{
                        "type":"string"
                    },
                    "billingProfileId":{
                        "type":"string"
                    },
                    "discountAmount":{
                        "type":"object",
                        "properties":{
                            "currency":{
                                "type":"string"
                            },
                            "value":{
                                "type":"number"
                            }
                        }
                    },
                    "recurringChargeFrequency":{
                        "type":"string"
                    },
                    "billingAccountId":{
                        "type":"string"
                    },
                    "dateAdded":{
                        "type":"string"
                    },
                    "price":{
                        "type":"object",
                        "properties":{
                            "currency":{
                                "type":"string"
                            },
                            "value":{
                                "type":"number"
                            }
                        }
                    },
                    "assetId":{
                        "type":"string"
                    },
                    "currency":{
                        "type":"object",
                        "properties":{
                            "currencyCode":{
                                "type":"string"
                            }
                        }
                    },
                    "usageNetAmount":{
                        "type":"object",
                        "properties":{
                            "currency":{
                                "type":"string"
                            },
                            "value":{
                                "type":"number"
                            }
                        }
                    },
                    "serviceId":{
                        "type":"string"
                    },
                    "skuId":{
                        "type":"string"
                    },
                    "serviceAccountId":{
                        "type":"string"
                    },
                    "quantity":{
                        "type":"number"
                    },
                    "recurringChargeDuration":{
                        "type":"string"
                    },
                    "discountPercent":{
                        "type":"number"
                    },
                    "dateModified":{
                        "type":"string"
                    },
                    "transactionDate":{
                        "description":"ISO formatted Date on which the service action should be triggered.",
                        "type":"string"
                    },
                    "usageUnitOfMeasure":{
                        "type":"string"
                    },
                    "suspendDate":{
                        "type":"string"
                    },
                    "customerAccountId":{
                        "type":"string"
                    },
                    "parentDisplay":{
                        "type":"string"
                    },
                    "attributes":{
                        "type":"string"
                    },
                    "descendantAssets":{
                        "type":"array",
                        "items":{
                            "$ref":"#/definitions/descendantAsset"
                        }
                    },
                    "activationDate":{
                        "type":"string"
                    },
                    "parentAsset":{
                        "type":"object",
                        "properties":{
                            "assetId":{
                                "type":"string"
                            },
                            "serviceId":{
                                "type":"string"
                            }
                        }
                    },
                    "resumeDate":{
                        "type":"string"
                    },
                    "recurringCharge":{
                        "type":"object",
                        "properties":{
                            "currency":{
                                "type":"string"
                            },
                            "value":{
                                "type":"number"
                            }
                        }
                    },
                    "status":{
                        "type":"object",
                        "properties":{
                            "displayValue":{
                                "type":"string"
                            },
                            "lookupCode":{
                                "type":"string"
                            },
                            "id":{
                                "type":"integer"
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "deactivationDate":{
                "type":"string"
            },
            "rootDisplay":{
                "type":"string"
            },
            "rootAsset":{
                "type":"object",
                "properties":{
                    "assetId":{
                        "type":"string"
                    },
                    "serviceId":{
                        "type":"string"
                    }
                }
            },
            "displayName":{
                "type":"string"
            },
            "billingProfileId":{
                "type":"string"
            },
            "discountAmount":{
                "type":"object",
                "properties":{
                    "currency":{
                        "type":"string"
                    },
                    "value":{
                        "type":"number"
                    }
                }
            },
            "recurringChargeFrequency":{
                "type":"string"
            },
            "billingAccountId":{
                "type":"string"
            },
            "dateAdded":{
                "type":"string"
            },
            "price":{
                "type":"object",
                "properties":{
                    "currency":{
                        "type":"string"
                    },
                    "value":{
                        "type":"number"
                    }
                }
            },
            "assetId":{
                "type":"string"
            },
            "currency":{
                "type":"object",
                "properties":{
                    "currencyCode":{
                        "type":"string"
                    }
                }
            },
            "usageNetAmount":{
                "type":"object",
                "properties":{
                    "currency":{
                        "type":"string"
                    },
                    "value":{
                        "type":"number"
                    }
                }
            },
            "serviceId":{
                "type":"string"
            },
            "skuId":{
                "type":"string"
            },
            "serviceAccountId":{
                "type":"string"
            },
            "quantity":{
                "type":"number"
            },
            "recurringChargeDuration":{
                "type":"string"
            },
            "discountPercent":{
                "type":"number"
            },
            "dateModified":{
                "type":"string"
            },
            "transactionDate":{
                "description":"ISO formatted Date on which the service action should be triggered.",
                "type":"string"
            },
            "usageUnitOfMeasure":{
                "type":"string"
            },
            "suspendDate":{
                "type":"string"
            },
            "customerAccountId":{
                "type":"string"
            },
            "parentDisplay":{
                "type":"string"
            },
            "attributes":{
                "type":"string"
            },
            "descendantAssets":{
                "type":"array",
                "items":{
                    "$ref":"#/definitions/descendantAsset"
                }
            },
            "activationDate":{
                "type":"string"
            },
            "parentAsset":{
                "type":"object",
                "properties":{
                    "assetId":{
                        "type":"string"
                    },
                    "serviceId":{
                        "type":"string"
                    }
                }
            },
            "resumeDate":{
                "type":"string"
            },
            "recurringCharge":{
                "type":"object",
                "properties":{
                    "currency":{
                        "type":"string"
                    },
                    "value":{
                        "type":"number"
                    }
                }
            },
            "status":{
                "type":"object",
                "properties":{
                    "displayValue":{
                        "type":"string"
                    },
                    "lookupCode":{
                        "type":"string"
                    },
                    "id":{
                        "type":"integer"
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• activationDate(optional): string
• assetId(optional): string
• attributes(optional): string
• billingAccountId(optional): string
• billingProfileId(optional): string
• currency(optional): object currency
• customerAccountId(optional): string
• dateAdded(optional): string
• dateModified(optional): string
• deactivationDate(optional): string
• descendantAssets(optional): array descendantAssets
• discountAmount(optional): object discountAmount
• discountPercent(optional): number
• displayName(optional): string
• parentAsset(optional): object parentAsset
• parentDisplay(optional): string
• price(optional): object price
• quantity(optional): number
• recurringCharge(optional): object recurringCharge
• recurringChargeDuration(optional): string
• recurringChargeFrequency(optional): string
• resumeDate(optional): string
• rootAsset(optional): object rootAsset
• rootDisplay(optional): string
• serviceAccountId(optional): string
• serviceId(optional): string
• skuId(optional): string
• status(optional): object status
• suspendDate(optional): string
• transactionDate(optional): string
  ISO formatted Date on which the service action should be triggered.
• usageNetAmount(optional): object usageNetAmount
• usageUnitOfMeasure(optional): string

{
    "type":"object",
    "properties":{
        "deactivationDate":{
            "type":"string"
        },
        "rootDisplay":{
            "type":"string"
        },
        "rootAsset":{
            "type":"object",
            "properties":{
                "assetId":{
                    "type":"string"
                },
                "serviceId":{
                    "type":"string"
                }
            }
        },
        "displayName":{
            "type":"string"
        },
        "billingProfileId":{
            "type":"string"
        },
        "discountAmount":{
            "type":"object",
            "properties":{
                "currency":{
                    "type":"string"
                },
                "value":{
                    "type":"number"
                }
            }
        },
        "recurringChargeFrequency":{
            "type":"string"
        },
        "billingAccountId":{
            "type":"string"
        },
        "dateAdded":{
            "type":"string"
        },
        "price":{
            "type":"object",
            "properties":{
                "currency":{
                    "type":"string"
                },
                "value":{
                    "type":"number"
                }
            }
        },
        "assetId":{
            "type":"string"
        },
        "currency":{
            "type":"object",
            "properties":{
                "currencyCode":{
                    "type":"string"
                }
            }
        },
        "usageNetAmount":{
            "type":"object",
            "properties":{
                "currency":{
                    "type":"string"
                },
                "value":{
                    "type":"number"
                }
            }
        },
        "serviceId":{
            "type":"string"
        },
        "skuId":{
            "type":"string"
        },
        "serviceAccountId":{
            "type":"string"
        },
        "quantity":{
            "type":"number"
        },
        "recurringChargeDuration":{
            "type":"string"
        },
        "discountPercent":{
            "type":"number"
        },
        "dateModified":{
            "type":"string"
        },
        "transactionDate":{
            "description":"ISO formatted Date on which the service action should be triggered.",
            "type":"string"
        },
        "usageUnitOfMeasure":{
            "type":"string"
        },
        "suspendDate":{
            "type":"string"
        },
        "customerAccountId":{
            "type":"string"
        },
        "parentDisplay":{
            "type":"string"
        },
        "attributes":{
            "type":"string"
        },
        "descendantAssets":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/descendantAsset"
            }
        },
        "activationDate":{
            "type":"string"
        },
        "parentAsset":{
            "type":"object",
            "properties":{
                "assetId":{
                    "type":"string"
                },
                "serviceId":{
                    "type":"string"
                }
            }
        },
        "resumeDate":{
            "type":"string"
        },
        "recurringCharge":{
            "type":"object",
            "properties":{
                "currency":{
                    "type":"string"
                },
                "value":{
                    "type":"number"
                }
            }
        },
        "status":{
            "type":"object",
            "properties":{
                "displayValue":{
                    "type":"string"
                },
                "lookupCode":{
                    "type":"string"
                },
                "id":{
                    "type":"integer"
                }
            }
        }
    }
}

Nested Schema : currency

Type: object

Show Source

• currencyCode(optional): string

{
    "type":"object",
    "properties":{
        "currencyCode":{
            "type":"string"
        }
    }
}

Nested Schema : descendantAssets

Type: array

Show Source

• Array of: object descendantAsset

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

Nested Schema : discountAmount

Type: object

Show Source

• currency(optional): string
• value(optional): number

{
    "type":"object",
    "properties":{
        "currency":{
            "type":"string"
        },
        "value":{
            "type":"number"
        }
    }
}

Nested Schema : parentAsset

Type: object

Show Source

• assetId(optional): string
• serviceId(optional): string

{
    "type":"object",
    "properties":{
        "assetId":{
            "type":"string"
        },
        "serviceId":{
            "type":"string"
        }
    }
}

Nested Schema : price

Type: object

Show Source

• currency(optional): string
• value(optional): number

{
    "type":"object",
    "properties":{
        "currency":{
            "type":"string"
        },
        "value":{
            "type":"number"
        }
    }
}

Nested Schema : recurringCharge

Type: object

Show Source

• currency(optional): string
• value(optional): number

{
    "type":"object",
    "properties":{
        "currency":{
            "type":"string"
        },
        "value":{
            "type":"number"
        }
    }
}

Nested Schema : rootAsset

Type: object

Show Source

• assetId(optional): string
• serviceId(optional): string

{
    "type":"object",
    "properties":{
        "assetId":{
            "type":"string"
        },
        "serviceId":{
            "type":"string"
        }
    }
}

Nested Schema : status

Type: object

Show Source

• displayValue(optional): string
• id(optional): integer
• lookupCode(optional): string

{
    "type":"object",
    "properties":{
        "displayValue":{
            "type":"string"
        },
        "lookupCode":{
            "type":"string"
        },
        "id":{
            "type":"integer"
        }
    }
}

Nested Schema : usageNetAmount

Type: object

Show Source

• currency(optional): string
• value(optional): number

{
    "type":"object",
    "properties":{
        "currency":{
            "type":"string"
        },
        "value":{
            "type":"number"
        }
    }
}

Nested Schema : descendantAsset

Type: object

Show Source

• activationDate(optional): string
• assetId(optional): string
• attributes(optional): string
• billingAccountId(optional): string
• billingProfileId(optional): string
• currency(optional): object currency
• customerAccountId(optional): string
• dateAdded(optional): string
• dateModified(optional): string
• deactivationDate(optional): string
• discountAmount(optional): object discountAmount
• discountPercent(optional): number
• displayName(optional): string
• parentAsset(optional): object parentAsset
• parentDisplay(optional): string
• price(optional): object price
• quantity(optional): number
• recurringCharge(optional): object recurringCharge
• recurringChargeDuration(optional): string
• recurringChargeFrequency(optional): string
• resumeDate(optional): string
• rootAsset(optional): object rootAsset
• rootDisplay(optional): string
• serviceAccountId(optional): string
• serviceId(optional): string
• skuId(optional): string
• status(optional): object status
• suspendDate(optional): string
• usageNetAmount(optional): object usageNetAmount
• usageUnitOfMeasure(optional): string

{
    "type":"object",
    "properties":{
        "deactivationDate":{
            "type":"string"
        },
        "rootDisplay":{
            "type":"string"
        },
        "rootAsset":{
            "type":"object",
            "properties":{
                "assetId":{
                    "type":"string"
                },
                "serviceId":{
                    "type":"string"
                }
            }
        },
        "displayName":{
            "type":"string"
        },
        "billingProfileId":{
            "type":"string"
        },
        "discountAmount":{
            "type":"object",
            "properties":{
                "currency":{
                    "type":"string"
                },
                "value":{
                    "type":"number"
                }
            }
        },
        "recurringChargeFrequency":{
            "type":"string"
        },
        "billingAccountId":{
            "type":"string"
        },
        "dateAdded":{
            "type":"string"
        },
        "price":{
            "type":"object",
            "properties":{
                "currency":{
                    "type":"string"
                },
                "value":{
                    "type":"number"
                }
            }
        },
        "assetId":{
            "type":"string"
        },
        "currency":{
            "type":"object",
            "properties":{
                "currencyCode":{
                    "type":"string"
                }
            }
        },
        "usageNetAmount":{
            "type":"object",
            "properties":{
                "currency":{
                    "type":"string"
                },
                "value":{
                    "type":"number"
                }
            }
        },
        "serviceId":{
            "type":"string"
        },
        "skuId":{
            "type":"string"
        },
        "serviceAccountId":{
            "type":"string"
        },
        "quantity":{
            "type":"number"
        },
        "recurringChargeDuration":{
            "type":"string"
        },
        "discountPercent":{
            "type":"number"
        },
        "dateModified":{
            "type":"string"
        },
        "usageUnitOfMeasure":{
            "type":"string"
        },
        "suspendDate":{
            "type":"string"
        },
        "customerAccountId":{
            "type":"string"
        },
        "parentDisplay":{
            "type":"string"
        },
        "attributes":{
            "type":"string"
        },
        "activationDate":{
            "type":"string"
        },
        "parentAsset":{
            "type":"object",
            "properties":{
                "assetId":{
                    "type":"string"
                },
                "serviceId":{
                    "type":"string"
                }
            }
        },
        "resumeDate":{
            "type":"string"
        },
        "recurringCharge":{
            "type":"object",
            "properties":{
                "currency":{
                    "type":"string"
                },
                "value":{
                    "type":"number"
                }
            }
        },
        "status":{
            "type":"object",
            "properties":{
                "displayValue":{
                    "type":"string"
                },
                "lookupCode":{
                    "type":"string"
                },
                "id":{
                    "type":"integer"
                }
            }
        }
    }
}

Nested Schema : currency

Type: object

Show Source

• currencyCode(optional): string

{
    "type":"object",
    "properties":{
        "currencyCode":{
            "type":"string"
        }
    }
}

Nested Schema : discountAmount

Type: object

Show Source

• currency(optional): string
• value(optional): number

{
    "type":"object",
    "properties":{
        "currency":{
            "type":"string"
        },
        "value":{
            "type":"number"
        }
    }
}

Nested Schema : parentAsset

Type: object

Show Source

• assetId(optional): string
• serviceId(optional): string

{
    "type":"object",
    "properties":{
        "assetId":{
            "type":"string"
        },
        "serviceId":{
            "type":"string"
        }
    }
}

Nested Schema : price

Type: object

Show Source

• currency(optional): string
• value(optional): number

{
    "type":"object",
    "properties":{
        "currency":{
            "type":"string"
        },
        "value":{
            "type":"number"
        }
    }
}

Nested Schema : recurringCharge

Type: object

Show Source

• currency(optional): string
• value(optional): number

{
    "type":"object",
    "properties":{
        "currency":{
            "type":"string"
        },
        "value":{
            "type":"number"
        }
    }
}

Nested Schema : rootAsset

Type: object

Show Source

• assetId(optional): string
• serviceId(optional): string

{
    "type":"object",
    "properties":{
        "assetId":{
            "type":"string"
        },
        "serviceId":{
            "type":"string"
        }
    }
}

Nested Schema : status

Type: object

Show Source

• displayValue(optional): string
• id(optional): integer
• lookupCode(optional): string

{
    "type":"object",
    "properties":{
        "displayValue":{
            "type":"string"
        },
        "lookupCode":{
            "type":"string"
        },
        "id":{
            "type":"integer"
        }
    }
}

Nested Schema : usageNetAmount

Type: object

Show Source

• currency(optional): string
• value(optional): number

{
    "type":"object",
    "properties":{
        "currency":{
            "type":"string"
        },
        "value":{
            "type":"number"
        }
    }
}

Back to Top