# End a store's contract POST /locations/{partner\_location\_id}/terminate Select code sampleFetchcURL ```js const url = 'https://data.creatorain.com/partner/v1/locations/store_123/terminate'; const options = { method: 'POST', headers: {Authorization: 'Bearer ', 'Content-Type': 'application/json'}, body: '{"effective_at":"2026-10-31T00:00:00Z","reason":"Merchant closed"}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```sh curl --request POST \ --url https://data.creatorain.com/partner/v1/locations/store_123/terminate \ --header 'Authorization: Bearer ' \ --header 'Content-Type: application/json' \ --data '{ "effective_at": "2026-10-31T00:00:00Z", "reason": "Merchant closed" }' ``` - Production (live stores; a live key is issued per partner) - Sandbox, for integration testing (test keys, test stores) Records that the contract has ended, stops the store being offered, and keeps every row. Nothing is deleted: the visits completed and videos published at the store are what its final invoice is made of. `effective_at` is when the CONTRACT ends and may be in the future (notice given in advance) or in the past (it ended before anybody told us). It is a different fact from when you told us, which we record separately. FINAL. A second call answers `200` with the same body and writes nothing, so a retry cannot rewrite the record. There is no un-terminate over the API; ask us if a contract has to be reinstated. ## Authorizations - **[partnerApiKey](/partner-api/reference/#partnerapikey)** ## Parameters ### Path Parameters **partner\_location\_id** required string <= 200 characters YOUR id for the store, as you sent it to `POST /locations`. #### Example ``` store_123 ``` ## Request Body Media typeapplication/json object **effective\_at** When the CONTRACT ends, RFC 3339. May be in the future or the past. Defaults to now. Different from when you told us, which we record separately. string format: date-time ### Example ``` 2026-10-31T00:00:00Z ``` **reason** string nullable <= 500 characters ### Example ``` Merchant closed ``` ## Responses ### 200 The store, now `terminated`. Media typeapplication/json The store as we hold it. ONE body for every verb on a location: the create’s 201 (also returned when a terminated store is added again), an identical repeat’s 200 (plus a `warning`), the `PATCH` response, and pause, resume and terminate. Write one receiver for it. `GET /locations/{partner_location_id}` returns this plus progress and the next visit (`LocationState`). object **location\_id** OUR id for the store. Stable, and what every other endpoint refers to it by. string format: uuid **partner\_location\_id** Your id, as you sent it (trimmed). string **status** `paused` means no NEW scheduling: creators are not offered the store and a new booking is refused, while bookings already confirmed are untouched. Resume opens it again. `terminated` means the contract has ended. Terminated wins over paused. string Allowed values: active paused terminated **network** A display label for the local creator pool, for example `example-pool`. Label only. string nullable **dashboard\_url** The embeddable merchant dashboard for this store, carrying a freshly minted 30 minute read-only token. Null when this deployment hosts no embedded dashboard, rather than a plausible URL pointing at nothing: an iframe rendered from a dead URL shows a merchant a blank panel, which is worse than a field you can branch on. Mint a fresh one with `POST /locations/{partner_location_id}/dashboard-token` when you render the embed. string nullable **timezone** IANA name for the store as we resolve it: the `timezone` you sent when you sent one, otherwise derived from the address. Null when neither yields one. string nullable **created\_at** RFC 3339 with the store’s offset. string nullable **hours** Whether we hold this store’s real opening hours, and where they came from. A store with no hours is still `active`: the contract exists and nothing about the enrolment failed. What it cannot do yet is take a creator booking, because our two date pickers are built from the stored week and an absent one disables both. `state: missing` is a request to chase the hours at source, which is the one place they actually exist. object **state** required string Allowed values: missing found **source** required Where the hours came from. `partner` means you sent them (`opening_hours`); the rest are our own lookups or an operator (`manual`). Null for a store never checked. string nullable Allowed values: partner places gemini website manual none **approval\_mode** How creators are approved for this store. `auto` (the default) books matching creators straight away. `sample_review` means the merchant first approves a batch of 5 sample creators (`GET /locations/{partner_location_id}/creator-samples`); nothing starts until that decision. string default: auto Allowed values: auto sample\_review **pricing** The store’s price for the month it is in: the same block as the quote, LOCKED when the store was confirmed. A change to `plan.videos_per_month` or `approval_mode` re-locks it from the next month (at the base price and your surcharge at that moment), shown meanwhile as `upcoming`. A later surcharge change does not move it. A store confirmed before pricing existed has no locked price: its block is worked out from the current default terms and marked `locked: false`, `source: default` (nothing is stored for it, and it shows the default creator cost range). NULL only when pricing is not set up at all. Read with a merchant’s store token, only the merchant price is returned (`creatorain` and `surcharge` are left out). object **currency** required string **billing\_unit** required string Allowed values: published\_video **creatorain** required What we bill the partner per published video. Not a fixed price. object **fee\_per\_video** required number **creator\_cost\_per\_video** required Estimate range of the creator cost per video (on a quote, and on a store with no locked price; null on a locked store). The bill uses the actual cost. object **min** number **max** number **billed\_as** required string Allowed values: creator\_cost\_plus\_fee **surcharge** required object **per\_video** number **plan\_surcharge** required The non-standard plan line, included in `merchant`. 0 / false for a standard plan. object **per\_video** number **applies** boolean **placeholder** True while the amount is provisional. boolean **merchant** required object **per\_video** required number **per\_month** required Per\_video x videos per month. Null for a store with no plan. number nullable **per\_season** required Per\_month x 3. number nullable **season\_videos** required integer nullable **note** required string **locked\_at** When the price in force was locked (UTC). Null when `locked` is false. string nullable **locked** False for a store with no locked price, priced from the current defaults. boolean **source** string Allowed values: locked default **upcoming** The price from `from_month` (the store’s next month), when a re-lock is waiting. object **from\_month** string **currency** string **creatorain** What we bill the partner per published video. Not a fixed price. object **fee\_per\_video** required number **creator\_cost\_per\_video** required Estimate range of the creator cost per video (on a quote, and on a store with no locked price; null on a locked store). The bill uses the actual cost. object **min** number **max** number **billed\_as** required string Allowed values: creator\_cost\_plus\_fee **surcharge** object **per\_video** number **plan\_surcharge** object **per\_video** number **applies** boolean **placeholder** boolean **merchant** object **per\_video** required number **per\_month** required Per\_video x videos per month. Null for a store with no plan. number nullable **per\_season** required Per\_month x 3. number nullable **season\_videos** integer nullable **first\_visit\_business\_days** The first-visit commitment for this store, in business days (Monday to Friday, store clock, skipping Thanksgiving Day, Christmas Day, New Year’s Day and any weekday the store’s own opening hours say it is closed), as agreed in your contract. Locked when the store is created. Null for a store created before this field existed. Show it as given. integer nullable **first\_visit\_due\_by** The store-local date the first creator visit is due by: `first_visit_business_days` counted from the day after the confirm day (`approved_at` when you sent it, otherwise the day the store was created). Locked at creation. string format: date nullable **rules** WHAT THIS STORE ASKS OF A CREATOR: the terms you set with `PATCH`, read back. Always present, ordered by attribute then operator, and `[]` for a store that asks nothing - which is what a store has until you send its first rule. THIS IS THE SAME ARRAY `PATCH` ACCEPTS, so the obvious read-modify-write is safe: read a store, change one entry, send the array back. `value` is returned in the shape we STORED it, which is the normalised one - a bare `20000` you sent for `follower_count` reads back as `{"count": 20000, "platform": null}`, and sending that object again changes nothing. It is deliberately NOT our internal effective rule set. Terms an operator set on our own dashboard through the older per-venue columns are not folded in here, because you can neither send nor clear those through this API and a term you cannot remove is worse than one you cannot see. Everything this array contains, `clear_rules` can remove. Array One term this store asks of a creator. `ethnicity`, `age_band` and `gender` are real members of our attribute list and are REFUSED with `422 validation_error` on both this API and our dashboard. Filtering paid work by a protected characteristic needs a written policy agreed with counsel, and until one exists we will not store the rule. `follower_count` takes `gte` or `lte` and a value of `{"count": N}`, optionally with `"platform"` to say WHERE the count is measured - `{"count": 20000, "platform": "tiktok"}` means twenty thousand on TikTok, not twenty thousand in total from somebody who also has a TikTok handle. `platform` and `language` take `eq` with one value or `in` with a list; over a creator who works on several, `eq` means “this is one of hers”, never “this is her only one”. `home_metro` (local creators only) takes `in`; `radius_miles` (within N miles of this store) takes `lte` and the miles, `25` or `{"miles": 25}`, from 1 to 500. Both are measured from this store’s own address, which we resolve when you write the rule and again when the address moves; an address we cannot place in a US city is a `422`. `performance_index` (content performance score, 0 to 100) and `engagement_rate` (percent, `3.5` means 3.5%) take `gte` and a number. They are floors. A creator we hold no answer for is decided by the store’s own policy, which passes by default - so adding a `language` rule today records your intent and excludes nobody until we hold languages. The follower bar, the platform, `home_metro`, `radius_miles`, `performance_index` and `engagement_rate` are the exception and always exclude a creator we cannot measure. object **attribute** required string Allowed values: follower\_count platform language home\_metro radius\_miles performance\_index engagement\_rate **operator** required string Allowed values: gte lte in eq **value** required One of: - [integer](#tab-panel-0-0) - [string](#tab-panel-0-1) - [Array](#tab-panel-0-2) - [object](#tab-panel-0-3) integer string Array object **count** integer **platform** string nullable Allowed values: instagram tiktok youtube facebook #### Example ```json { "partner_location_id": "store_123", "status": "active", "network": "example-pool", "timezone": "America/Los_Angeles", "created_at": "2026-09-10T13:22:00-07:00", "hours": { "state": "missing", "source": "partner" }, "approval_mode": "auto", "pricing": { "currency": "USD", "billing_unit": "published_video", "creatorain": { "fee_per_video": 10, "creator_cost_per_video": { "min": 20, "max": 40 }, "billed_as": "creator_cost_plus_fee" }, "surcharge": { "per_video": 10 }, "plan_surcharge": { "per_video": 5, "applies": false, "placeholder": true }, "merchant": { "per_video": 100, "per_month": 200, "per_season": 600 }, "season_videos": 6, "source": "locked", "upcoming": { "from_month": "2026-11", "creatorain": { "fee_per_video": 10, "creator_cost_per_video": { "min": 20, "max": 40 }, "billed_as": "creator_cost_plus_fee" }, "merchant": { "per_video": 100, "per_month": 200, "per_season": 600 } } }, "first_visit_due_by": "2026-10-06", "rules": [ { "attribute": "follower_count", "operator": "gte", "value": { "count": 20000, "platform": "tiktok" } }, { "attribute": "platform", "operator": "eq", "value": "tiktok" } ] } ``` ### 400 `validation_error`. `field` names the offending parameter. Media typeapplication/json object **error** required object **code** required The stable value to branch on. string Allowed values: unauthorized forbidden\_ip rate\_limited validation\_error location\_already\_exists location\_not\_found location\_terminated reservation\_not\_found conflict internal\_error **message** required A human sentence. Copy, not contract; it may be reworded. string **field** The request field at fault, dotted for a nested one (`plan.term_months`). string #### Example ```json { "error": { "code": "unauthorized" } } ``` ### 401 `unauthorized`. A missing, malformed, unknown or revoked key; or an invalid, expired or wrong-store dashboard token. One answer for every case on purpose: the holder of a bad credential learns nothing from the difference. Media typeapplication/json object **error** required object **code** required The stable value to branch on. string Allowed values: unauthorized forbidden\_ip rate\_limited validation\_error location\_already\_exists location\_not\_found location\_terminated reservation\_not\_found conflict internal\_error **message** required A human sentence. Copy, not contract; it may be reworded. string **field** The request field at fault, dotted for a nested one (`plan.term_months`). string #### Example ```json { "error": { "code": "unauthorized" } } ``` ### 404 `location_not_found`. No store of this key carries that `partner_location_id`. Media typeapplication/json object **error** required object **code** required The stable value to branch on. string Allowed values: unauthorized forbidden\_ip rate\_limited validation\_error location\_already\_exists location\_not\_found location\_terminated reservation\_not\_found conflict internal\_error **message** required A human sentence. Copy, not contract; it may be reworded. string **field** The request field at fault, dotted for a nested one (`plan.term_months`). string #### Example ```json { "error": { "code": "unauthorized" } } ``` ### 429 `rate_limited`. Over this key’s requests-per-minute ceiling. Media typeapplication/json object **error** required object **code** required The stable value to branch on. string Allowed values: unauthorized forbidden\_ip rate\_limited validation\_error location\_already\_exists location\_not\_found location\_terminated reservation\_not\_found conflict internal\_error **message** required A human sentence. Copy, not contract; it may be reworded. string **field** The request field at fault, dotted for a nested one (`plan.term_months`). string #### Example ```json { "error": { "code": "unauthorized" } } ```