Skip to content

Commit 92337af

Browse files
authored
Remove references to External Purchases API bulk endpoint (#940)
1 parent 4ec3b8d commit 92337af

File tree

1 file changed

+8
-72
lines changed

1 file changed

+8
-72
lines changed

openapi-spec/external-purchases-api.yaml

Lines changed: 8 additions & 72 deletions
Original file line numberDiff line numberDiff line change
@@ -69,15 +69,13 @@ tags:
6969
# Base URL
7070
7171
The base URL for the External Purchases API is `https://api.revenuecat.com/`.
72-
72+
7373
# Endpoints
7474
75-
The API has two endpoints, `POST/receipts/external` and `POST/receipts/external/bulk`.
75+
The API has one endpoint, `POST/receipts/external`.
7676
7777
`POST/receipts/external` is used for requests with a single purchase and/or payment, and processes them right away. Calling [Get Customer](/docs/api-v1#tag/customers/operation/subscribers) right after will return the updated entitlements.
7878
79-
`POST/receipts/external/bulk` is used only for bulk updates/imports. These updates will happen in the background and could take some time to process.
80-
8179
For more details check the [API reference](#operation/track-external-purchases).
8280
8381
## Payload
@@ -388,10 +386,9 @@ tags:
388386
1. In the scenario when the third party payment service provider retains commissions in case of a refund, Revenuecat does not track negative revenues. Meaning, that in such cases, you will see data discrepancies with the equivalent of the commission retained by the payment service provider.
389387
5. Entitlement identifier:
390388
1. We support only new entitlement identifiers ([not the legacy version](/docs/integrations/webhooks/event-types-and-fields#subscription-lifecycle-events-fields)).
391-
6. [Backfill logic](#tag/Backfill-Logic), on import transactions (using the /bulk endpoint) are not supported.
392-
7. [Backfills](#tag/Backfill-Logic) that modify `current_period_ends_at` date, do not alter existing Events, which means that the Customer history won't reflect accurately the most up to date `expiration_at_ms`.
393-
8. If a different `source_subscription_identifier` gets provided, doesn’t matter if it’s the same product, we can end up with concurrent transactions
394-
9. `EXPIRATION` Events are not fired automatically. The developer needs to explicitly send a request to the External Purchases API endpoint when `status` changed to `expired`.
389+
6. [Backfills](#tag/Backfill-Logic) that modify `current_period_ends_at` date, do not alter existing Events, which means that the Customer history won't reflect accurately the most up to date `expiration_at_ms`.
390+
7. If a different `source_subscription_identifier` gets provided, doesn’t matter if it’s the same product, we can end up with concurrent transactions
391+
8. `EXPIRATION` Events are not fired automatically. The developer needs to explicitly send a request to the External Purchases API endpoint when `status` changed to `expired`.
395392
- name: External Purchases
396393
description: Operations to track external subscriptions and purchases.
397394
paths:
@@ -434,40 +431,6 @@ paths:
434431
"$ref": "#/components/schemas/ExceededQuotaError"
435432
security:
436433
- api_key: []
437-
"/v1/receipts/external/bulk":
438-
tag: External Purchases
439-
post:
440-
tags:
441-
- External Purchases
442-
summary: Tracks the status of multiple external purchases
443-
operationId: track-external-purchases-bulk
444-
requestBody:
445-
content:
446-
application/json:
447-
schema:
448-
"$ref": "#/components/schemas/ExternalPurchaseBulkRequest"
449-
required: true
450-
responses:
451-
'202':
452-
description: Successful Response
453-
content:
454-
application/json:
455-
schema:
456-
"$ref": "#/components/schemas/ExternalPurchaseBulkResponse"
457-
'400':
458-
description: Bad Request
459-
content:
460-
application/json:
461-
schema:
462-
"$ref": "#/components/schemas/BadRequestError"
463-
'409':
464-
description: Conflict
465-
content:
466-
application/json:
467-
schema:
468-
"$ref": "#/components/schemas/ConflictError"
469-
security:
470-
- api_key: []
471434
components:
472435
schemas:
473436
AmountInLocalCurrency:
@@ -639,34 +602,7 @@ components:
639602
- source_product_identifier
640603
- updated_at
641604
title: ExternalPurchase
642-
ExternalPurchaseBulkRequest:
643-
properties:
644-
purchases:
645-
anyOf:
646-
- items:
647-
anyOf:
648-
- "$ref": "#/components/schemas/ExternalPurchase"
649-
- "$ref": "#/components/schemas/ExternalSubscription"
650-
type: array
651-
title: Purchases
652-
description: A list of external purchases to track
653-
payments:
654-
anyOf:
655-
- "$ref": "#/components/schemas/ExternalSubscriptionPayment"
656-
- "$ref": "#/components/schemas/ExternalPurchasePayment"
657-
title: Payments
658-
description: A list of external payments to track
659-
additionalProperties: false
660-
type: object
661-
title: ExternalPurchaseBulkRequest
662-
ExternalPurchaseBulkResponse:
663-
properties:
664-
status_url:
665-
anyOf:
666-
- type: string
667-
title: Status Url
668-
type: object
669-
title: ExternalPurchaseBulkResponse
605+
670606
ExternalPurchasePayment:
671607
properties:
672608
object:
@@ -720,7 +656,7 @@ components:
720656
- unspecified_offer
721657
title: Active Offer Type
722658
description: The type of offer that was active when the payment was processed.
723-
active_offer:
659+
active_offer:
724660
type: string
725661
title: Active Offer Identifier
726662
description: The identifier of the offer that was active when the payment was processed.
@@ -919,7 +855,7 @@ components:
919855
- unspecified_offer
920856
title: Active Offer Type
921857
description: The type of offer that was active when the payment was processed.
922-
active_offer:
858+
active_offer:
923859
type: string
924860
title: Active Offer Identifier
925861
description: The identifier of the offer that was active when the payment was processed.

0 commit comments

Comments
 (0)