# Zuora Sync

Synchronise subscription data between Zuora and Limio. Import subscriptions created directly in Zuora or refresh existing Limio subscriptions with upstream Zuora changes.

## Sync Zuora Subscription

> Synchronise a Zuora subscription with Limio. Use this to import subscriptions created directly in Zuora (outside of a Limio shop) or to refresh existing Limio subscriptions with the latest upstream Zuora data. If the subscription does not yet exist in Limio, a new subscription and customer account will be created.

```json
{"openapi":"3.1.0","info":{"title":"Limio Commerce API","version":"1.0.0"},"tags":[{"name":"Zuora Sync","description":"Synchronise subscription data between Zuora and Limio. Import subscriptions created directly in Zuora or refresh existing Limio subscriptions with upstream Zuora changes."}],"servers":[{"url":"https://{tenant}/api","description":"Limio environment API","variables":{"tenant":{"default":"your-environment.prod.limio.com","description":"Your Limio environment hostname, e.g. `acme.prod.limio.com` or `acme-sandbox.prod.limio.com`."}}}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"OAuth 2.0 Bearer token for authenticated API access. Required for order submission, object management, and administrative operations.\n\nObtain a token via the OAuth flow described in [OAuth Bearer Token](https://docs.limio.com/developers/api-documentation/authentication-overview/oauth-bearer-token).\n\nPass the token in the `Authorization` header: `Bearer <token>`"}},"schemas":{"SyncZuoraDataResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Indicates if the sync has been completed"},"id":{"description":"The id of the subscription created in Limio","type":"string"},"owner":{"description":"The id of the owner identity of the subscription created in Limio","type":"string"}}}},"responses":{"401Response":{"description":"Unauthorized — the request lacks valid authentication credentials. Verify your Bearer token or API key is correct and has not expired.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}},"502Response":{"description":"Bad Gateway — an upstream service returned an unexpected response. This typically indicates an issue with the request payload (e.g. invalid field values, missing required fields) or a transient infrastructure error. Retry the request, and if the issue persists, verify the request body matches the expected schema.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Human-readable error description."}}}}}}}},"paths":{"/plugins/zuora/sync/subscription/{id}":{"post":{"operationId":"syncZuoraData","summary":"Sync Zuora Subscription","tags":["Zuora Sync"],"description":"Synchronise a Zuora subscription with Limio. Use this to import subscriptions created directly in Zuora (outside of a Limio shop) or to refresh existing Limio subscriptions with the latest upstream Zuora data. If the subscription does not yet exist in Limio, a new subscription and customer account will be created.","parameters":[{"name":"id","in":"path","required":true,"description":"The Zuora subscription ID to synchronise (e.g. `A-S00000271`).","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SyncZuoraDataResponse"}}}},"401":{"$ref":"#/components/responses/401Response"},"502":{"$ref":"#/components/responses/502Response"}}}}}}
```
