Import Users and Subscriptions
Changed onLoads users, their aliases, their attributes and their subscription history into the subscriptions store — the same store the SDK and store webhooks write to, read back by GET /v3/users/{app_user_id}/subscriptions.
Send at most 500 users and 2000 subscriptions per request; a larger batch is rejected with 400 and will fail identically on retry.
Every write is idempotent and merged by the timestamps on the record, so re-posting a batch is safe and a 5xx should be retried with the same body. Subscription status is derived from the lifecycle timestamps you send (refunded_at, billing_issues_detected_at, grace_period_expires_at, unsubscribe_detected_at, expires_at) rather than supplied directly.
A request is applied in three passes — identity, then ownership, then subscription state — and it is NOT all-or-nothing: if a later pass fails, the earlier ones have already been written. This is safe to recover from and needs no cleanup on your side; re-post the same batch and the already-written records are rewritten identically. Do not treat a failed request as though nothing landed, and do not attempt to compensate by deleting.
Send updated_at as the time the store last reported the subscription, not the time of the request: it decides whether an imported row outranks a live store event for the same subscription.
Attributes sent here reach the subscriptions store only — they do not emit analytics events. Use POST /v3/users/{app_user_id}/attributes for attributes that should also reach charts and campaigns.
Rate limited per application: a 429 carries Retry-After. The store is written by a single process that is also handling live subscription events, so imports are paced deliberately.
Requires imports:write scope.
Request
- Base URLhttps://api.superwall.com
- URLhttps://api.superwall.com/v2/imports/subscriptions
- Auth
- HTTP bearer
- or API key in cookie accounts_superwall_token
- or HTTP bearer
Request body
Response
Success
Changes
- warning
added the new
credentials_missingenum value to the/response property for the response status - warning
added the new
credentials_missingenum value to the/response property for the response status - warning
added the new
credentials_missingenum value to the/response property for the response status - warning
added the new
credentials_missingenum value to the/response property for the response status - warning
added the new
credentials_missingenum value to the/response property for the response status - info
added
subschema #1subschema #2to the response bodyanyOflist for the response status - info
added
subschema #1subschema #2subschema #3subschema #4subschema #5to the response bodyanyOflist for the response status - info
removed
subschema #1subschema #2from the response bodyanyOflist for the response status - info
removed
subschema #1subschema #2subschema #3subschema #4subschema #5from the response bodyanyOflist for the response status
- warning
- breaking
the
request property type changed fromstringto no type - breaking
the
//request property type changed fromarrayto no type - breaking
the
//request property type changed fromobjectto no type - breaking
the
//request property type changed fromarrayto no type - breaking
the
response's property type changed fromstringto no type for status - breaking
the
response's property type changed fromstringto no type for status - breaking
the
response's property type changed fromstringto no type for status - breaking
the
response's property type changed fromstringto no type for status - breaking
the
response's property type changed fromstringto no type for status - breaking
the
response's property type changed fromstringto no type for status - breaking
the
response's property type changed fromstringto no type for status - breaking
the
response's property type changed fromstringto no type for status - breaking
the
response's property type changed fromstringto no type for status - breaking
the
response's property type changed fromstringto no type for status - breaking
the
response's property type changed fromstringto no type for status - breaking
the
response's property type changed fromstringto no type for status - breaking
the
response's property type changed fromstringto no type for status - breaking
the
response's property type changed fromstringto no type for status - breaking
the
response's property type changed fromstringto no type for status - breaking
the
response's property type changed fromnumberto no type for status - breaking
the
response's property type changed fromstringto no type for status - breaking
the
response's property type changed fromstringto no type for status - breaking
the
response's property type changed fromstringto no type for status - breaking
the
response's property type changed fromstringto no type for status - breaking
the
response's property type changed fromnumberto no type for status - info
added
subschema #1to therequest propertyanyOflist - info
added
subschema #1to the//request propertyanyOflist - info
added
subschema #1to the//request propertyanyOflist - info
added
subschema #1to the//request propertyanyOflist - info
the
request property's minLength was decreased from1to0 - info
added
subschema #1subschema #2to the response bodyanyOflist for the response status - info
added
subschema #1subschema #2subschema #3subschema #4subschema #5to the response bodyanyOflist for the response status - info
added
subschema #2to the response bodyanyOflist for the response status - info
removed
subschema #1: Internal Server Errorsubschema #2: Database Query Errorfrom the response bodyanyOflist for the response status - info
removed
subschema #1: Missing API Keysubschema #2: Invalid API Key Formatsubschema #3: Invalid API Keysubschema #4: Authentication Failedsubschema #5: Invalid Sessionfrom the response bodyanyOflist for the response status - info
removed
subschema #2: Bad Requestfrom the response bodyanyOflist for the response status - info
added
subschema #1to theresponse propertyanyOflist for the response status - info
added
subschema #1to theresponse propertyanyOflist for the response status - info
added
subschema #1to theresponse propertyanyOflist for the response status - info
added
subschema #1to theresponse propertyanyOflist for the response status - info
added
subschema #1to theresponse propertyanyOflist for the response status - info
added
subschema #1to theresponse propertyanyOflist for the response status - info
added
subschema #1to theresponse propertyanyOflist for the response status - info
added
subschema #1to theresponse propertyanyOflist for the response status - info
added
subschema #1to theresponse propertyanyOflist for the response status - info
added
subschema #1to theresponse propertyanyOflist for the response status - info
added
subschema #1to theresponse propertyanyOflist for the response status - info
added
subschema #1to theresponse propertyanyOflist for the response status - info
added
subschema #1to theresponse propertyanyOflist for the response status - info
added
subschema #1to theresponse propertyanyOflist for the response status - info
added
subschema #1to theresponse propertyanyOflist for the response status - info
added
subschema #1to theresponse propertyanyOflist for the response status - info
added
subschema #1to theresponse propertyanyOflist for the response status - info
added
subschema #1to theresponse propertyanyOflist for the response status - info
added
subschema #1to theresponse propertyanyOflist for the response status - info
added
subschema #1to theresponse propertyanyOflist for the response status - info
added
subschema #1to theresponse propertyanyOflist for the response status - info
added
subschema #1to theresponse propertyanyOflist for the response status - info
removed the
api_errorenum value from theresponse property for the response status - info
removed the
api_errorenum value from theresponse property for the response status - info
removed the
api_errorenum value from theresponse property for the response status - info
removed the
api_errorenum value from theresponse property for the response status - info
removed the
authentication_errorenum value from theresponse property for the response status - info
removed the
authentication_errorenum value from theresponse property for the response status - info
removed the
authentication_errorenum value from theresponse property for the response status - info
removed the
authentication_errorenum value from theresponse property for the response status - info
removed the
authentication_failedenum value from theresponse property for the response status - info
removed the
authentication_failedenum value from theresponse property for the response status - info
removed the
authentication_failedenum value from theresponse property for the response status - info
removed the
authentication_failedenum value from theresponse property for the response status - info
removed the
idempotency_key_in_useenum value from theresponse property for the response status - info
removed the
idempotency_key_in_useenum value from theresponse property for the response status - info
removed the
idempotency_key_in_useenum value from theresponse property for the response status - info
removed the
idempotency_key_in_useenum value from theresponse property for the response status - info
removed the
insufficient_permissionsenum value from theresponse property for the response status - info
removed the
insufficient_permissionsenum value from theresponse property for the response status - info
removed the
insufficient_permissionsenum value from theresponse property for the response status - info
removed the
insufficient_permissionsenum value from theresponse property for the response status - info
removed the
internal_errorenum value from theresponse property for the response status - info
removed the
internal_errorenum value from theresponse property for the response status - info
removed the
internal_errorenum value from theresponse property for the response status - info
removed the
internal_errorenum value from theresponse property for the response status - info
removed the
invalid_api_keyenum value from theresponse property for the response status - info
removed the
invalid_api_keyenum value from theresponse property for the response status - info
removed the
invalid_api_keyenum value from theresponse property for the response status - info
removed the
invalid_api_keyenum value from theresponse property for the response status - info
removed the
invalid_api_key_formatenum value from theresponse property for the response status - info
removed the
invalid_api_key_formatenum value from theresponse property for the response status - info
removed the
invalid_api_key_formatenum value from theresponse property for the response status - info
removed the
invalid_api_key_formatenum value from theresponse property for the response status - info
removed the
invalid_referenceenum value from theresponse property for the response status - info
removed the
invalid_referenceenum value from theresponse property for the response status - info
removed the
invalid_referenceenum value from theresponse property for the response status - info
removed the
invalid_referenceenum value from theresponse property for the response status - info
removed the
invalid_request_errorenum value from theresponse property for the response status - info
removed the
invalid_request_errorenum value from theresponse property for the response status - info
removed the
invalid_request_errorenum value from theresponse property for the response status - info
removed the
invalid_request_errorenum value from theresponse property for the response status - info
removed the
invalid_sessionenum value from theresponse property for the response status - info
removed the
invalid_sessionenum value from theresponse property for the response status - info
removed the
invalid_sessionenum value from theresponse property for the response status - info
removed the
invalid_sessionenum value from theresponse property for the response status - info
removed the
missing_api_keyenum value from theresponse property for the response status - info
removed the
missing_api_keyenum value from theresponse property for the response status - info
removed the
missing_api_keyenum value from theresponse property for the response status - info
removed the
missing_api_keyenum value from theresponse property for the response status - info
removed the
organization_requiredenum value from theresponse property for the response status - info
removed the
organization_requiredenum value from theresponse property for the response status - info
removed the
organization_requiredenum value from theresponse property for the response status - info
removed the
organization_requiredenum value from theresponse property for the response status - info
removed the
parameter_invalidenum value from theresponse property for the response status - info
removed the
parameter_invalidenum value from theresponse property for the response status - info
removed the
parameter_invalidenum value from theresponse property for the response status - info
removed the
parameter_invalidenum value from theresponse property for the response status - info
removed the
parameter_missingenum value from theresponse property for the response status - info
removed the
parameter_missingenum value from theresponse property for the response status - info
removed the
parameter_missingenum value from theresponse property for the response status - info
removed the
parameter_missingenum value from theresponse property for the response status - info
removed the
parameter_unknownenum value from theresponse property for the response status - info
removed the
parameter_unknownenum value from theresponse property for the response status - info
removed the
parameter_unknownenum value from theresponse property for the response status - info
removed the
parameter_unknownenum value from theresponse property for the response status - info
removed the
permission_errorenum value from theresponse property for the response status - info
removed the
permission_errorenum value from theresponse property for the response status - info
removed the
permission_errorenum value from theresponse property for the response status - info
removed the
permission_errorenum value from theresponse property for the response status - info
removed the
rate_limit_errorenum value from theresponse property for the response status - info
removed the
rate_limit_errorenum value from theresponse property for the response status - info
removed the
rate_limit_errorenum value from theresponse property for the response status - info
removed the
rate_limit_errorenum value from theresponse property for the response status - info
removed the
rate_limit_exceededenum value from theresponse property for the response status - info
removed the
rate_limit_exceededenum value from theresponse property for the response status - info
removed the
rate_limit_exceededenum value from theresponse property for the response status - info
removed the
rate_limit_exceededenum value from theresponse property for the response status - info
removed the
resource_already_existsenum value from theresponse property for the response status - info
removed the
resource_already_existsenum value from theresponse property for the response status - info
removed the
resource_already_existsenum value from theresponse property for the response status - info
removed the
resource_already_existsenum value from theresponse property for the response status - info
removed the
resource_archivedenum value from theresponse property for the response status - info
removed the
resource_archivedenum value from theresponse property for the response status - info
removed the
resource_archivedenum value from theresponse property for the response status - info
removed the
resource_archivedenum value from theresponse property for the response status - info
removed the
resource_missingenum value from theresponse property for the response status - info
removed the
resource_missingenum value from theresponse property for the response status - info
removed the
resource_missingenum value from theresponse property for the response status - info
removed the
resource_missingenum value from theresponse property for the response status - info
removed the
side_effect_failedenum value from theresponse property for the response status - info
removed the
side_effect_failedenum value from theresponse property for the response status - info
removed the
side_effect_failedenum value from theresponse property for the response status - info
removed the
side_effect_failedenum value from theresponse property for the response status - info
removed the
unsupported_operationenum value from theresponse property for the response status - info
removed the
unsupported_operationenum value from theresponse property for the response status - info
removed the
unsupported_operationenum value from theresponse property for the response status - info
removed the
unsupported_operationenum value from theresponse property for the response status - info
removed the
upstream_service_errorenum value from theresponse property for the response status - info
removed the
upstream_service_errorenum value from theresponse property for the response status - info
removed the
upstream_service_errorenum value from theresponse property for the response status - info
removed the
upstream_service_errorenum value from theresponse property for the response status
This list may be incomplete.
- breaking