Sync customer subscriptions

/subscription_system/sync_customer_subscriptions

Target audience: Developers

Sync customer subscriptions¶

Introduction¶

Syncs the customer's subscriptions to match with those in the external subscription system. When performing bulk operations against this method you should do them in sequence and NOT in parallel.

URI¶

Environment	URI
Stage	https://payway-api.stage.adeprimo.se/external/api/v1/subscription_system/sync_customer_subscriptions
Production	https://backend.worldoftulo.com/external/api/v1/subscription_system/sync_customer_subscriptions

Requirements¶

Identity	Scope
No	`/external/subscription_system/w`

Parameters¶

Field	Required	Type	Description
customer_number	Required	String	The customer number to synchronize. Size range: ..50 Allowed values: "/^[a-zA-Z-_0-9]+$/"

Curl Example¶

curl --request PUT \
  --url https://payway-api.stage.adeprimo.se/external/api/v1/subscription_system/sync_customer_subscriptions \
  --header 'accept: application/json' \
  --header 'authorization: Bearer token' \
  --header 'content-type: application/json' \
  --data '{
              "customer_number": "1234567890"
          }'

Response¶

Field	Description
id	The id of the updated account.

Example Response: Successfully accepted shared subscription¶

HTTP 200 Updated
{
    "id": "50f3ac249f6aef294d000007"
}

Errors¶

Example error response¶

HTTP 400 Bad Request
{
    "code": "invalid_parameter",
    "field": "account_id",
    "message": "Parameter must match format (/^[a-f\d]{24}$/)"
}

HTTP 400 Bad Request¶

Name	Type	Description
invalid_parameter	Object	Validation error on any of the fields in the posted json
json_parser_error	Object	The request body could not be parsed as valid json
invalid_content_type_error	Object	The requests Content-Type header isn't set to application/json
unknown_parameter	Object	One or more of the fields in the posted json was not recognized

HTTP 404 Not Found¶

Name	Type	Description
not_found	Object	The account or product could not be found

HTTP 500 Internal Server Error¶

Name	Type	Description
internal_server_error	Object	Something unexpected happened server side